Get started - Get started with Liveblocks, Tiptap, Yjs, and JavaScript

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

Quickstart

  1. Install Liveblocks, Yjs, and Tiptap

    $npm install @liveblocks/client @liveblocks/yjs yjs @tiptap/core @tiptap/pm @tiptap/starter-kit  @tiptap/extension-collaboration @tiptap/extension-collaboration-cursor
  2. Create an HTML element

    <div id="editor"></div>
  3. Set up your collaborative Tiptap text editor

    app.js
    import { createClient } from "@liveblocks/client";import LiveblocksProvider from "@liveblocks/yjs";import * as Y from "yjs";import { Editor } from "@tiptap/core";import StarterKit from "@tiptap/starter-kit";import Collaboration from "@tiptap/extension-collaboration";import CollaborationCursor from "@tiptap/extension-collaboration-cursor";
    // Set up Liveblocks clientconst client = createClient({ publicApiKey: "",});
    // Enter a multiplayer roomconst { room, leave } = client.enterRoom("my-room", { initialPresence: {},});
    // Set up Yjs document, shared text, and Liveblocks Yjs providerconst yDoc = new Y.Doc();const yText = yDoc.getText("tiptap");const yProvider = new LiveblocksProvider(room, yDoc);
    // Set up the Tiptap editorconst element = document.querySelector("editor");const editor = new Editor({ element, extensions: [ StarterKit.configure({ // The Collaboration extension comes with its own history handling history: false, }), // Register the Yjs document with Tiptap Collaboration.configure({ document: yDoc, }), CollaborationCursor.configure({ provider: yProvider, }), ],});
  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 Tiptap text editor inside your JavaScript application.