yjs-getting-started

What problem does it solve?

This guide removes friction when configuring Yjs to sync over Durable Streams by walking through peer dependency installation, running the required local servers, creating a collaborative Y.Doc, and verifying presence and synchronization so edits reliably replicate across clients.

Core Features & Use Cases

• HTTP-based Yjs syncing: Use standard HTTP with SSE or long-polling to sync Yjs documents without WebSocket infrastructure.
• Developer-focused dev server setup: Start a DurableStreamTestServer and a YjsServer that proxies storage operations for local development and testing.
• Presence and awareness: Integrate y-protocols/awareness to track remote users and share presence metadata such as cursor position or user info.
• Use Case: Rapidly prototype collaborative editors (rich text or code) that resume across reconnections and provide replayable change history.

Quick Start

Start a DurableStreamTestServer and a YjsServer locally, create a Y.Doc, instantiate a YjsProvider with baseUrl set to your service root and docId set to your document, and confirm the provider emits a synced event.