React sync board

React Sync Board is a set of React components/hooks that allow you to add real time collaboration on a board to any React project.

You can see it live in AirBoardGame website.

Demo

You can access the demo storybook here.

Installation

npm install react-sync-board

You need an up and running instance of the wire.io server to be able to synchronize two boards. You can achieve that by using npm >= v7 and execute:

npx wire.io

See wire.io for more information.

Usage

See the examples in src/stories to know how to use it.

(Documentation in progress)

Storybook

To start the storybook, clone this repository then execute:

npm ci
npm start

Remember to start a wire.io instance as explained above.