Quick Start

Before you start

This walkthrough runs from a clone of the repository. If you have not built it yet, follow Installation first (mise install, just deps, just build-all).

1. Run the kanban example

From the repository root:

just example kanban

This command builds the example and starts a Strata server at http://localhost:8000. The server uses dev-strata-token unless you set STRATA_TOKEN.

2. Open two tabs

Open http://localhost:8000 in two browser tabs. Add, move, or delete a card in one tab. The change appears in the other tab.

Both tabs connect to the same WebSocket endpoint:

WebSocket endpoint

ws://localhost:8000/socket/websocket?token=dev-strata-token

3. View the admin page

While the example is running, open:

Admin page

http://localhost:8000/admin?token=dev-strata-token

The read-only admin page lists the kanban document, its size, the number of active connections, and who is present.

What just happened

1. Each browser opened a WebSocket with the token.
2. The server checked each token before it accepted the connection.
3. The application sent a join frame for the kanban document.
4. The server sent a snapshot of the document state.
5. Each edit became a delta frame.
6. The server merged and wrote the state. It then sent the state to the other tab.
7. If a connection closes, the example connects and joins the document again.

Other examples

just example todo runs a checklist application. just example workspace runs the document composition example. Each example is under examples/ in the repository. To run the server on its own without an example, use just server.

Next: Build Your First Application shows how to connect an application to Strata.