This example shows how to build a collaborative text editor with Liveblocks, Yjs, Slate, and Next.js.
As users edit the document, changes will be automatically persisted and synced—allowing for an editor that updates in real-time across clients. Users will also be able to see who see each other’s cursors in the document.
Run the following command to try this example locally:
npx create-liveblocks-app@latest --example nextjs-yjs-slate --api-keyThis will download the example and ask permission to open your browser, enabling you to automatically get your API key from your liveblocks.io account.
Read more
Alternatively, you can set up your project manually:
- Install all dependencies with
npm install - Create an account on liveblocks.io
- Copy your secret key from the dashboard
- Create an
.env.localfile and add your secret key as theLIVEBLOCKS_SECRET_KEYenvironment variable - Run
npm run devand go to http://localhost:3000
Read more
To both deploy on Vercel, and run the example locally, use the following command:
npx create-liveblocks-app@latest --example nextjs-yjs-slate --vercelThis will download the example and ask permission to open your browser, enabling you to deploy to Vercel.
Read more
After forking this example on CodeSandbox, create the LIVEBLOCKS_SECRET_KEY environment variable as a secret.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent