What this path gives you
In one focused session, you will:- Start a local NodalMerge host.
- Run demo and playground apps from this repo.
- Validate shared state and collaboration behavior.
- Inspect runtime protocol traffic and replay snapshots.
Prerequisites
- Local
nodalmergeartifacts prepared for package-mode host and sdk workflows. - Host can run on
http://127.0.0.1:5074. - You can run
npm run dev:appsfrom this repository root.
Step 1: Run quickstart baseline
Completequickstart first to align core model and room-level sync expectations.
Success check:
- You can explain room, transaction, sync, and speculative vs authoritative behavior.
Step 2: Start host and app surfaces
Followdeveloper-experience/apps:
- Start demo host.
- Start all app surfaces.
- Open
infinite-room-workspace,collab-maps,replay-lab, andprotocol-inspector.
- All app UIs load and can target the same room id.
Step 3: Validate collaboration flows
Infinite room workspace
- Use
npm sdk + wasmmode. - Apply shared document action.
- Publish presence and send peer signal from a second browser window.
Collab maps
- Add shared pins from one window.
- Confirm pins appear in second window.
- You can observe convergent shared state changes across windows.
Step 4: Inspect runtime protocol and replay
Protocol inspector
- Apply presets (
Presence,Peer lifecycle,Welcome/session,Replay/query). - Select messages and inspect raw payloads.
- Export a trace snippet.
Replay lab
- Capture snapshots at multiple interaction points.
- Use range controls to inspect event windows.
- You can map observed runtime events back to app actions.
Step 5: Connect observations to docs
Use these docs while reviewing your captured behavior:protocol/websocket-messagesapi-reference/websocket-commandssdk/javascriptoperators/troubleshooting