https://github.com/stefanw/channels-yroom

Django Channels WebSocket consumer and worker for synchronizing Yjs clients
https://github.com/stefanw/channels-yroom

channels django websocket yjs yjs-provider

Last synced: 6 months ago
JSON representation

Django Channels WebSocket consumer and worker for synchronizing Yjs clients

• Host: GitHub
• URL: https://github.com/stefanw/channels-yroom
• Owner: stefanw
• License: mit
• Created: 2023-04-17T09:08:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-10T12:45:57.000Z (almost 2 years ago)
• Last Synced: 2025-03-23T23:34:10.078Z (7 months ago)
• Topics: channels, django, websocket, yjs, yjs-provider
• Language: Python
• Homepage: https://channels-yroom.readthedocs.io/en/latest/
• Size: 134 KB
• Stars: 20
• Watchers: 2
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Channels-Yroom

![PyPI](https://img.shields.io/pypi/v/channels-yroom)

`channels-yroom` is a Django Channels WebSocket consumer and worker for synchronizing Yjs clients. It implements the network protocol for Yjs doc synchronization and awareness updates and makes them available as Django Channels WebSocket consumer and worker.

## Documentation

[Read the documentation](https://channels-yroom.readthedocs.io/en/latest/)

## Showcase: text collaboration example

The `example` folder contains a simple project that uses `y-prosemirror` to allow for realtime collaboration on rich text.

Run the included Docker compose file to check it out:

```sh

docker compose up

# Then visit localhost:8000

```

## Development

Project uses `hatch` for the development workflow:

```

pip install hatch

hatch run +py=3.10 test:test

```

## License

MIT