Get started - Get started with Liveblocks, CodeMirror, Yjs, and Vue.js

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

Quickstart

1. Install Liveblocks, Yjs, and CodeMirror

   Every Liveblocks package should use the same version.

   $npm install @liveblocks/client @liveblocks/yjs yjs codemirror @codemirror/lang-javascript y-codemirror.next

2. Initialize the liveblocks.config.ts file

   We can use this file later to define types for our application.

   $npx create-liveblocks-app@latest --init --framework javascript

3. Set up your collaborative CodeMirror code editor

   Editor.vue

   <script setup>import { ref, onMounted, onUnmounted } from "vue";import { createClient } from "@liveblocks/client";import { getYjsProviderForRoom } 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";
   const parent = ref(null);const leave = ref(null);const view = ref(null);
   // Set up Liveblocks clientconst client = createClient({  publicApiKey: "pk_prod_xxxx…xxxxxxpk_prod_xxxxxxxxxxxxxxxxxxxxxxxx",});
   // Enter a multiplayer roomconst info = client.enterRoom("my-room");const room = info.room;leave.value = info.leave;
   // Set up Yjs document, shared text, and Liveblocks Yjs providerconst yProvider = getYjsProviderForRoom(room);const yDoc = yProvider.getYDoc();const yText = yDoc.getText("codemirror");
   onMounted(() => {  // Set up CodeMirror and extensions  const state = EditorState.create({    doc: yText.toString(),    extensions: [      basicSetup,      javascript(),      yCollab(ytext, yProvider.awareness, { undoManager }),    ],  });
     // Attach CodeMirror to element  view.current = new EditorView({    state,    parent: parent.value,  });});
   onUnmounted(() => {  view?.destroy();  leave.value?.();});</script>
   <template>  <div ref="parent" /></template>

4. 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 Vue.js application.

• @liveblocks/yjs API Reference
• @liveblocks/client API Reference
• CodeMirror website