A proof-of-concept collaborative editor based on tiptap and yjs.
Start a Yjs websocket server :
cd collaborative-editor
npm install
PORT=9999 HOST=0.0.0.0 npx y-websocket
Set the REACT_APP_YJS_WEBSOCKET_SERVER_URL environment variable before starting the npm dev server; for example:
cd collaborative-editor
REACT_APP_YJS_WEBSOCKET_SERVER_URL=ws://example.com:9999 npm start
This will fail if for some reason there are still some daemons running from a previous execution of tiptap or toygrid. You will need to kill those processes manually if so.
cd ~/lab/tiptap/collaborative-editor # or wherever you've cloned this repo
make
This will start the Yjs server (y-websocket) and a crapload of node processes,
all of which you can see by saying ps -af.
The editor app is a node process listening on port 3000, reachable at e.g.
http://europa.d4.t7a.org:3000/, which you can see at netstat -tulpn
You'll also see the Yjs server (that syncs editor keystrokes) listening on port 3099. It will just say "okay" if you go to e.g. http://europa.d4.t7a.org:3099/ in a browser. (The editor uses a complex API to talk to the Yjs server).
- hit ^C
This will kill all of the server processes, which you can verify with:
ps -af
netstat -tulpn
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify