Skip to content

orbitdb/example-orbitdb-todomvc

Repository files navigation

Example OrbitDB TodoMVC

Gitter Matrix Discord

Serverless and collaborative Todo lists

TodoMVC application using OrbitDB as a database for the todo list and IPFS as the storage and networking. This is an example to demonstrate how OrbitDB enables multi-user, real-time and serverless editing of a dataset.

Status: Work in progress.

LIVE DEMO

Background

This example is based on React TodoMVC.

  • Initializing OrbitDB and IPFS happens in store
  • OrbitDB calls happen in model
  • The database and app are hooked together in app

Install

git clone <repo>
cd repo/
npm install
npm run build

Usage

npm start

Open your browser at http://127.0.0.1:8080

Collaborative editing by multiple users

To collaborate on a TODO list, open the same url in another browser or incognito window. You should see the TODO lists sync automatically.

Contribute

We'd be happy have contributions! If you find any issues, have suggestions for new features or would like to improve the project, please open an issue.

For specific guidelines for contributing to this repository, check out the Contributing guide. For more on contributing to OrbitDB in general, take a look at the @OrbitDB welcome repository. Please note that all interactions in @orbitdb fall under our Code of Conduct.

License

MIT © 2017-2019 Haja Networks Oy