This example shows how to build a collaborative code editor with Liveblocks, Yjs, CodeMirror, and Next.js.
As users edit the code, changes will be automatically persisted and synced—allowing for collaborative code editing experience. Users will also be able to see who else is currently online and each others cursors.
Run the following command to try this example locally:
npx create-liveblocks-app@latest --example nextjs-yjs-codemirror --api-key
This 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 public key from the dashboard
- Create an
.env.local
file and add your public key as theLIVEBLOCKS_SECRET_KEY
environment variable - Run
npm run dev
and 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-codemirror --vercel
This 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.