hocuspocus

Open source

The Yjs CRDT WebSocket backend for conflict-free real-time collaboration in your app.

2.5K stars0 likes0 views

About

The Yjs CRDT WebSocket backend for conflict-free real-time collaboration in your app.

[!TIP] Help us chart the future of Hocuspocus by telling us about your needs in a short survey. Plus, you’ll get a chance to earn a $50 gift card. Take the survey →

Hocuspocus

A plug & play collaboration backend based on Y.js.

Documentation

The full documentation is a available on hocuspocus.dev/introduction.

Cloud Hosting

You want to use Hocuspocus, but don't want to care about hosting? Check our Cloud Offering: Tiptap Collab

Feedback

Send all your questions, feedback and bug reports to [email protected] or create an issue here.

Usage

The following example is a example setup you need to start a WebSocket server. By default, it’s listening on http://127.0.0.1 (or prefixed with the WebSocket protocol on ws://127.0.0.1):

javascript

import { Server } from '@hocuspocus/server'
import { SQLite } from '@hocuspocus/extension-sqlite'

const server = new Server({
  port: 1234,

  async onConnect() {
    console.log('')
  },

  extensions: [
    new SQLite({
      database: 'db.sqlite',
    }),
  ],
});

server.listen();