@starbase/starbase NPM

Starbase

Starbase Core Libraries

This project provides the Starbase Core Libaries for Node.js and the Web in a single package. Please refer to the Starbase Alpha Manual for links to documentation for using each of the Starbase Libraries.

Adding Starbase to your Project

On the Web

<script src="/path/to/starbase.min.js"></script>

On the Web via jsdelivr CDN

<script src="https://cdn.jsdelivr.net/npm/@starbase/starbase"></script>

In NodeJS

npm install @starbase/starbase

Using Starbase

on the Web using starbase.min.js:

const starbase = Starbase();

const Database = starbase.Database;
const Memstore = starbase.Memstore;
const Channels = starbase.Channels;
const Client = starbase.Client;
const theRules = starbase.theRules;
const Auth = starbase.Auth;
const Admin = starbase.Admin;
const Profiles = starbase.Profiles;
const Files = starbase.Files;
const Socket = starbase.Socket;
const Realtime = starbase.Realtime;
const Cryptic = starbase.Cryptic;
const CryptoDB = starbase.CryptoDB;
const Encryption = starbase.Encryption;
const Topics = starbase.Topics;
const Push = starbase.Push;

in Node.js using @starbase/starbase:

const Starbase = require('@starbase/starbase');
const starbase = Starbase();

const Database = starbase.Database;
const Memstore = starbase.Memstore;
const Channels = starbase.Channels;
const Client = starbase.Client;
const Starfire = starbase.Starfire;
const theRules = starbase.theRules;
const Auth = starbase.Auth;
const Admin = starbase.Admin;
const Profiles = starbase.Profiles;
const Files = starbase.Files;
const Socket = starbase.Socket;
const Realtime = starbase.Realtime;
const Cryptic = starbase.Cryptic;
const CryptoDB = starbase.CryptoDB;
const Encryption = starbase.Encryption;
const Topics = starbase.Topics;
const Push = starbase.Push;
const Pages = starbase.Pages;