/peerpad

📝 Online editor providing collaborative editing in really real-time using CRDTs and IPFS.

Primary LanguageJavaScriptMIT LicenseMIT

PeerPad logo

PeerPad is a decentralized editor that allows concurrent writing of text. Besides making live changes to a given document, it allows read-only nodes to follow the changes in real-time. It also allows you to publish a self-contained snapshot of the document to IPFS.

🔓 PeerPad is experimental software. It hasn't been audited, and as such shouldn't be used to create or share sensitive information.

Install

$ git clone https://github.com/ipfs-shipyard/peerpad.git
$ cd peerpad
$ npm install

Use locally

$ npm start

Head out to http://localhost:3000

Build

To build into the build dir, run:

$ npm run build

Deploy

You can self-host your own Peerpad. For that, deploy the build directory (after you have run the npm run build command).

HTTPS

Some dependencies (like webcrypto) require that you're serving under HTTPS — unless it's localhost...

Docs

Core API

See peerpad-core.

Want to hack on PeerPad?

License

MIT