https://github.com/orbitdb-archive/example-orbitdb-todomvc-updated
TodoMVC app using OrbitDB
https://github.com/orbitdb-archive/example-orbitdb-todomvc-updated
database example ipfs orbit-db serverless todomvc
Last synced: about 1 year ago
JSON representation
TodoMVC app using OrbitDB
- Host: GitHub
- URL: https://github.com/orbitdb-archive/example-orbitdb-todomvc-updated
- Owner: orbitdb-archive
- License: mit
- Created: 2018-09-09T15:25:07.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2021-05-07T14:54:10.000Z (about 5 years ago)
- Last Synced: 2025-03-28T16:43:51.864Z (about 1 year ago)
- Topics: database, example, ipfs, orbit-db, serverless, todomvc
- Language: JavaScript
- Size: 271 KB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TodoMVC with OrbitDB
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
> Serverless and collaborative Todo lists
TodoMVC application using [OrbitDB](https://github.com/orbitdb/orbit-db) as a database for the todo list and [IPFS](https://github.com/ipfs/js-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](https://ipfs.io/ipfs/QmTJGHccriUtq3qf3bvAQUcDUHnBbHNJG2x2FYwYUecN43/)**
## Install
```
git clone
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](https://github.com/tastejs/todomvc/tree/master/examples/react).
- Initializing OrbitDB and IPFS happens in [store](https://github.com/natachadelarosa/example-orbitdb-todomvc-updated/blob/master/src/utils/store.js)
- OrbitDB calls happen in [model](https://github.com/natachadelarosa/example-orbitdb-todomvc-updated/blob/master/src/utils/todoModel.js)
- The database and app are hooked together in [index](https://github.com/natachadelarosa/example-orbitdb-todomvc-updated/blob/master/src/index.js#L23)
## 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](https://gitter.im/orbitdb/Lobby), or in the [issues section](https://github.com/orbitdb/example-orbitdb-todomvc-updated/issues).
For specific guidelines for contributing to this repository, check out the [Contributing guide](CONTRIBUTING.md). For more on contributing to OrbitDB in general, take a look at the [@OrbitDB welcome repository](https://github.com/orbitdb/welcome). Please note that all interactions in @orbitdb fall under our [Code of Conduct](CODE_OF_CONDUCT.md).
## License
Copyright (c) 2018-2019 Natacha De la Rosa