Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/substance/collab-writer
Realtime collaboration example.
https://github.com/substance/collab-writer
Last synced: about 2 months ago
JSON representation
Realtime collaboration example.
- Host: GitHub
- URL: https://github.com/substance/collab-writer
- Owner: substance
- Created: 2016-12-24T13:14:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-27T16:17:08.000Z (about 4 years ago)
- Last Synced: 2024-04-15T12:47:30.220Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 14
- Watchers: 6
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CollabWriter
CollabWriter sets up a minimal [realtime collaboration infrastructure](./server.js).
STATUS: Experimental
## Install
```
$ git clone https://github.com/substance/examples.git
$ npm install
$ npm run build
$ npm start
```- Open two browser windows at `http://localhost:7777`.
- Start typing and see the changes in realtime in the other window.## Development
You can build in development mode, where source file changes trigger a rebuild of client and server. The Server will be bundled into `server.cjs.js`. We recommend using Google Chrome for development.
```
$ npm run dev
```Open a separate terminal window and run node.
```js
$ node server.cjs.js
```We recommend that you start the server with a visual debugger, such as devtool.
```js
$ devtool server.cjs.js
```