Getting started

Set up access, then publish and consume state with the JavaScript client. This section takes you from a new account to a working publish/subscribe loop.

What you will do#

  1. Create credentials — register an owner and save the API key and key pair from the Welcome page.
  2. Publish state — define an object and write its first value with the JavaScript HTTP client.
  3. Receive updates — configure WebSocket delivery (or read state over HTTP) so subscribers see changes as they happen.
Account → credentials → object + state → delivery / read

The HTTP API is the source of truth for configuration and state. Delivery channels notify consumers; they can always fetch the authoritative value again when needed.

What you need#

Before you start:

  • A modern browser (for registration and browser examples)
  • Node.js 22.12 or later (for the quickstart scripts)
  • A place to store secrets (password manager or local env file — not source control)

You will leave onboarding with four values: owner, API key, public key, and private key. Tutorials and client examples use the owner in resource names (for example simple:counter@YOUR_OWNER) and the API key to authenticate requests.

Treat the API key and private key as secrets. Do not commit them or ship privileged keys in public browser apps.

Follow these pages in order the first time:

Inside JavaScript, start with Quickstart to create an object and publish state, then Deliver and read state to wire WebSocket updates or HTTP reads.

After Getting started#

When the basic loop works, pick a fuller walkthrough or dig into the API:

© 2024 BigState