Skip to content

orbitdb/example-orbitdb-todomvc-updated

Repository files navigation

TodoMVC with OrbitDB

This project was bootstrapped with Create React App.

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.

Work in progress

LIVE DEMO

Install

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

Run

npm start

Open your browser at http://localhost:3000

Available Scripts

In the project directory, you can run:

  • npm start

  • npm test

  • npm run build

  • npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

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.

More Info

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 index

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.

You can reach us on Gitter, or in the issues section.

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

Copyright (c) 2018-2019 Natacha De la Rosa