Introduction
Sync Store synchronizes JSON values between app instances using an HTTP and WebSocket API. The TypeScript client provides local caching, queued offline writes and reconciliation after reconnecting.
The API runs on Bun with MongoDB storage. Two clients share server data by user ID, while each instance maintains its own local cache and pending-operation outbox.
Start here
-
Self hosted: run the API and MongoDB with Docker, without installing Bun.
-
Getting started: run MongoDB, initialize the API and create a development key.
-
Playground: write JSON and observe a second, independent client receive it.
-
Client SDK and React: integrate storage into an application.
-
Offline synchronization: understand reconnect, pending writes and delivery limits.
-
HTTP and Socket.IO: inspect the wire contract and response envelope.
-
Deployment: build and operate the service.
Before production
Prisma 8 MongoDB support is early access. A shared API key does not authenticate individual users; use a trusted backend to enforce user identity. Realtime broadcasting currently requires a single API process, and delivery is at least once. Read the security guide and operational limits before deployment.