upstream-hocuspocus/README.md

> [!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 →](https://docs.google.com/forms/d/e/1FAIpQLSeUS8S1iZTud58GBSD_d4c8lfUvkZHvzU99kWxP1wnNZnPKpw/viewform?usp=header)**

# Hocuspocus
A plug & play collaboration backend based on [Y.js](https://github.com/yjs/yjs).

[![Build Status](https://github.com/ueberdosis/hocuspocus/workflows/build/badge.svg)](https://github.com/ueberdosis/hocuspocus/actions)
[![Version](https://img.shields.io/npm/v/@hocuspocus/server.svg?label=version)](https://www.npmjs.com/package/@hocuspocus/server)
[![Downloads](https://img.shields.io/npm/dm/@hocuspocus/server.svg)](https://npmcharts.com/compare/@hocuspocus/server?minimal=true)
[![License](https://img.shields.io/npm/l/@hocuspocus/server.svg)](https://www.npmjs.com/package/@hocuspocus/server)
[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)

## Documentation
The full documentation is a available on [hocuspocus.dev/introduction](https://tiptap.dev/docs/hocuspocus/introduction).

## Cloud Hosting

You want to use Hocuspocus, but don't want to care about hosting? Check our [Cloud Offering: Tiptap Collab](https://tiptap.dev/collab)


## Feedback
Send all your questions, feedback and bug reports to [humans@tiptap.dev](mailto:humans@tiptap.dev) or [create an issue](https://github.com/ueberdosis/hocuspocus/issues/new/choose) 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](http://127.0.0.1) (or prefixed with the WebSocket protocol on ws://127.0.0.1):

```js
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();
```

## Community
For help, discussion about best practices, or any other conversation:

[Join the Tiptap Discord Server](https://discord.gg/WtJ49jGshW)

## Sponsors 💖
<table>
  <tr>
    <td align="center">
      <a href="https://tiptap.dev/">
        <img src="https://unavatar.io/github/ueberdosis" width="100"><br>
        <strong>Tiptap</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://cargo.site/">
        <img src="https://unavatar.io/github/cargo" width="100"><br>
        <strong>Cargo</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://saga.so/">
        <img src="https://unavatar.io/saga.so" width="100"><br>
        <strong>Saga</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://www.gamma.app/">
        <img src="https://unavatar.io/gamma.app" width="100"><br>
        <strong>Gamma</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://www.getoutline.com/">
        <img src="https://unavatar.io/github/outline" width="100"><br>
        <strong>Outline</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://ahrefs.com/">
        <img src="https://unavatar.io/ahrefs.com" width="100"><br>
        <strong>Ahrefs</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/brickdoc">
        <img src="https://unavatar.io/github/brickdoc" width="100"><br>
        <strong>Brickdoc</strong>
      </a>
    </td>
    <td align="center">
      <a href="https://www.sanalabs.com/">
        <img src="https://unavatar.io/github/sanalabs" width="100"><br>
        <strong>Sana</strong>
      </a>
    </td>
  </tr>
  <tr>
    <td align="center">
      <a href="https://poggio.io">
        <img src="https://unavatar.io/github/poggiolabs" width="100"><br>
        <strong>Poggio</strong>
      </a>
    </td>
  </tr>
</table>

… and hundreds of awesome inviduals.

Using Hocuspocus in production? Invest in the future of Hocuspocus and [become a sponsor!](https://github.com/sponsors/ueberdosis)

## Contributing
Please see [CONTRIBUTING](docs/contributing.md) for details.

## Contributors
[kris](https://github.com/kriskbx) (who wrote the initial version), [Tom Moor](https://github.com/tommoor), [YousefED (@TypeCellOS)](https://github.com/YousefED) and [many more](../../contributors).

## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.