| 1 | # startupjs react-sharedb
|
| 2 |
|
| 3 | > Run `ShareDB` in `React`
|
| 4 |
|
| 5 | ## What it does
|
| 6 |
|
| 7 | 1. Brings real-time collaboration to React using [ShareDB](https://github.com/share/sharedb);
|
| 8 | 2. Uses [Racer](https://derbyjs.com/docs/derby-0.10/models) to add a `model`
|
| 9 | to your app to do any data manipulations;
|
| 10 | 3. The `model` acts as a global singleton state, so you can use it as a
|
| 11 | replacement for other state-management systems like `Redux` or `MobX`;
|
| 12 | 4. Makes the `render` reactive similar to how it's done in `MobX` --
|
| 13 | rerendering happens whenever any `model` data you used in `render`
|
| 14 | changes.
|
| 15 |
|
| 16 | ## Installation
|
| 17 |
|
| 18 | It's recommended to just use `startupjs` package, since it proxies the API of `@startupjs/react-sharedb`.
|
| 19 |
|
| 20 | ```
|
| 21 | yarn add startupjs
|
| 22 | ```
|
| 23 |
|
| 24 | ## Usage with Hooks
|
| 25 |
|
| 26 | [Hooks syntax documentation](/packages/react-sharedb-hooks)
|
| 27 |
|
| 28 | ## Usage with Classes
|
| 29 |
|
| 30 | [Classes syntax documentation](/packages/react-sharedb-classes)
|
| 31 |
|
| 32 | ## Licence
|
| 33 |
|
| 34 | MIT
|
| 35 |
|
| 36 | (c) Decision Mapper - http://decisionmapper.com
|