How to create a collaborative code editor with CodeMirror, Yjs, Next.js, and Liveblocks
In this tutorial, we’ll be building a collaborative code editor using CodeMirror, Yjs, Next.js, and Liveblocks.
Run the following command to install the CodeMirror, Yjs, and Liveblocks packages:
The first step in connecting to Liveblocks is to set up an authentication
Here’s an example using the older API routes format in
Let’s initialize the
liveblocks.config.ts file in which you’ll set up the
We’ll also need another type for this tutorial. After creating the config file, open it up and insert the following:
Next, we can create the front end client which will be responsible for
communicating with the back end. You can do this by modifying
your config file, and passing the location of your endpoint.
Liveblocks uses the concept of rooms, separate virtual spaces where people
collaborate. To create a real-time experience, multiple users must be connected
to the same room. Create a file in the current directory within
/app, and name
Now that we’ve set up Liveblocks, we can start integrating Monaco and Yjs in the
And here is the
Editor.module.css file to make sure your multiplayer text
editor looks nice and tidy.
Next, add the
CollaborativeEditor into the page file, and place it inside the
Room component we created earlier. We should now be seeing a basic
To add live cursors to the code editor, we can get the
userInfo for the
current user with
attach it Yjs awareness. After adding the following, you should see live
We can style these cursors by placing CSS in a global CSS file.
From this point onwards, you can build your CodeMirror app as normal! For example, should you wish to add a basic undo/redo toolbar to your app:
Add some matching styles:
You can then import this into your editor to enable basic CodeMirror features:
Along with building out your code editor, you can now use other Liveblocks
features, such as Presence. The
useOthers hook allows us to
view information about each user currently online, and we can turn this into a
live avatars component.
And here’s the styles:
You can then import this to your editor to see it in action:
Note that the cursors and avatars match in color and name, as the info for both is sourced from the Liveblocks authentication endpoint.
You should now see the complete editor, along with live cursors, live avatars, and some basic features! On GitHub we have a working example of this multiplayer code editor.