Skip to content

kapv89/yjs-scalable-ws-backend

Repository files navigation

Demo

https://www.loom.com/share/f152340723af40e7bacd3f67fafb2d69?sid=2bab7fa4-4de0-4bc8-a6ce-05166b96af4d

About

Example of crdt websocket backend for y-js to be used with y-websocket provider with persitence to an api server. Uses redis-pubsub for horizontal scaling. Also provides logic of read-only/read+write access to documents.

Usage

  1. git clone [email protected]:kapv89/yjs-scalable-ws-backend.git
  2. cd yjs-scalable-ws-backend
  3. npm ci - the postinstall script fix_y-websocket.js fixes the dev-dependency y-websocket
  4. npm run build
  5. cp .env.example .env.test.local
  6. Update .env.test.local as per your system.
  7. docker-compose up to start redis
  8. npm run watch in a terminal tab
  9. npm run test
  10. Go through src/__tests__/app.test.ts to view details for tests

USE WITH k_yrs_go

About

Horizontally scalable YJS socket-server with persistence to external api

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •