vigzmv / ipfs-crdt-shared-editing

Decentralized Real-Time Collaborative Documents - Conflict-free editing in the browser using js-IPFS and CRDTs.

IPFS CRDT Shared Editing

"Decentralized Real-Time Collaborative Documents - Conflict-free editing in the browser using js-IPFS and CRDTs"

An distributed application that allows for several users to edit the same document at the same time, something similar to Google Docs, but without any coordinating server.

Check it out Live Here, Open it on few tabs or devices and start typing...

IPFS

IPFS stands for Interplanetary File System, and is much more than a file system. It’s an entire network stack for the decentralised and peer-to-peer web, allowing you to build truly serverless web applications.

More about IPFS here ipfs.io.

CRDT

Conflict-Free Replicated Data Types provides a conflict-free manner of replicating data across multiple nodes without ever having to elect a leader or use another type of centralized authority to reach consensus.

The project uses js-ipfs, which is a Javascript implementation of IPFS that works in Node.js and in a modern browser.

The Project

A text editor that requires no server but yet, allows several users to edit it in a collaborative fashion. We can call it “google docs without google for plain text”.

Project Live Here.

Set up

Pre-requisites

• Have Node.js version 6 or greater installed

Install

$ git clone https://github.com/vigzmv/IPFS-CRDT-shared-editing.git
$ cd IPFS-CRDT-shared-editing
$ yarn install

Build

$ yarn build

Run

$ yarn 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:1234 and start typing!!

License

MIT

ipfs-crdt-shared-editing's Issues

Tab crashes in firefox nightly

I was trying the demo site, and after a few minutes, the browser tab crashed:

I'm testing this on ubuntu 17.10, with firefox nightly 58.0a1 (2017-11-05) (64-bit)

Synchronization is not working

I opened the demo site on two windows, but they don't seem to synchronize.

I'm testing this on ubuntu 17.10, with firefox nightly 58.0a1 (2017-11-05) (64-bit)