Giter VIP home page Giter VIP logo

peerpad's Introduction

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.

Test it live at https://peerpad.net

๐Ÿ”“ 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

peerpad's People

Contributors

pgte avatar olizilla avatar alanshaw avatar daviddias avatar waozixyz avatar nicola avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.