miguelramosfdz / shared-editing-demo

Demo of shared text editing using Yjs and IPFS

Shared editing demo using IPFS and CRDT

This codebase was developed to demostrate how to use IPFS in conjuction with Y.js, a CRDT library.

Links:

• Transcript
• Video of Demo
• Live Demo

Set up

Pre-requisites

• Have Node.js version 6 or greater installed

Install

> git clone https://github.com/ipfs-labs/shared-editing-demo.git
> cd shared-editing-demo
> npm install

Build

> npm run build

Run

> npm start

Open in browser

Using a modern browser that supports WebRTC, like a recent version of Chrome or Firefox, open several windows of http://localhost:12345.

Known issues

This Demo uses WebRTC to establish the connections between nodes. WebRTC is a CPU intensive protocol and not all Browsers will behave correctly, depending on their implementation of WebRTC or the resources available on the machine that they are running. This is a known issue and something the js-ipfs team is looking at alternatives to solve.

License

MIT