Get started - Get started with Liveblocks, CodeMirror, Yjs, and Svelte

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start adding collaboration to your Svelte application using the APIs from the @liveblocks/yjs package.

Quickstart

  1. Install Liveblocks, Yjs, and CodeMirror

    $npm install @liveblocks/client @liveblocks/yjs yjs codemirror @codemirror/lang-javascript y-codemirror.next
  2. Set up your collaborative CodeMirror code editor

    Editor.svelte
    <script>import { onMount, onDestroy } from "svelte";import { createClient } from "@liveblocks/client";import LiveblocksProvider from "@liveblocks/yjs";import * as Y from "yjs";import { yCollab } from "y-codemirror.next";import { EditorView, basicSetup } from "codemirror";import { EditorState } from "@codemirror/state";import { javascript } from "@codemirror/lang-javascript";
    let parent;
    // Set up Liveblocks clientconst client = createClient({ publicApiKey: "",});
    onMount(() => { // Enter a multiplayer room const { room, leave } = client.enterRoom("my-room", { initialPresence: {}, });
    // Set up Yjs document, shared text, undo manager, and Liveblocks Yjs provider const yDoc = new Y.Doc(); const yText = yDoc.getText("codemirror"); const undoManager = new Y.UndoManager(yText); const yProvider = new LiveblocksProvider(room, yDoc);
    // Set up CodeMirror and extensions const state = EditorState.create({ doc: yText.toString(), extensions: [ basicSetup, javascript(), yCollab(yText, yProvider.awareness, { undoManager }), ], });
    // Attach CodeMirror to element const view = new EditorView({ state, parent, });
    return () => { view.destroy(); leave(); };});</script>
    <div bind:this={parent}></div>
  3. Next: set up authentication

    By default, Liveblocks is configured to work without an authentication endpoint where everyone automatically has access to rooms. This approach is great for prototyping and marketing pages where setting up your own security isn’t always required. If you want to limit access to a room for certain users, you’ll need to set up an authentication endpoint to enable permissions.

    Set up authentication

What to read next

Congratulations! You now have set up the foundation for your collaborative CodeMirror code editor inside your Svelte application.