Installation
Depending on how you intend to use Relaybox, we provide both client and server SDK libraries. They can be used individually or combined to form a robust suite of services for your real-time applications.
All our services are open source and free to use. To get started, head over to GitHub and download the offline platform emulator.
RelayBox Client Library SDK
To begin using RelayBox in your client-side codebase, we first need to install the library via npm.
npm install @relaybox/client
Once the installation is complete, you'll be able to access the service by initializing your application.
Relaybox REST Service Library
To begin using Relaybox REST services, we first need to install the REST services library found at:
npm install @relaybox/rest
Once the installation is complete, you'll be able to use the rest application SDK
Relaybox CLI
Once you've installed the SDK pacakges, you can choose to connect directly to RelayBox Cloud or install the offline platform emulator via the CLI toolkit for local development and testing.
To download the CLI, simply run the following command in your terminal.
npm install -g relaybox
When the package has installed sucessfully, you will have access to the RelayBox cli. The cli exposes various commands that will get your applications up and running.
For more information about RelayBox Offline, please refer to the documentation