OrbitDB is a serverless, distributed, peer-to-peer database. OrbitDB uses IPFS as its data storage and Libp2p Pubsub to automatically sync databases with peers. It's an eventually consistent database that uses Merkle-CRDTs for conflict-free database writes and merges making OrbitDB an excellent choice for p2p and decentralized apps, blockchain applications and local-first web applications.
OrbitDB is currently funded by OpenCollective. Please visit our page there to learn more.
The quickest way to get started with OrbitDB is to install the core module:
npm i @orbitdb/core
Repositories and Architecture
The @orbitdb organization on GitHub contains many different repositories. For the most part, these are either code which relates to OrbitDB, or are various non-code repositories for documentation and the like.
Awesome OrbitDB, which is an attempt to list everything that is using OrbitDB, or could help people. Basically, what has been built?
OrbitDB Core - The main repo for OrbitDB.
Ethereum Identity Provider - An Ethereum-based identity provider for OrbitDB.
DID Identity Provider - A Decentralized IDentitifer identity provider for OrbitDB.
The best place to find out what is available is likely by asking in the Matrix. If you know of any other repos that ought to be included in this section, point them out to us!
There are other repositories that aren't in the organization around the web which are important - for instance, of course, ipfs. For now, these are the main ones in the @orbitdb organization.
If there is something missing form this list, please let us know! Either open a PR or an issue, and we'll add it. Thank you.
We maintain OrbitDB accounts on these registries:
Please contribute! Dive into the issues!
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to OrbitDB are subject to the OrbitDB Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.
This repository is only for documents. All of these are licensed under the CC-BY-SA 3.0 license © 2016-2018 Protocol Labs Inc., Haja Networks Oy. Any code is under a MIT © 2016-2018 Protocol Labs Inc., Haja Networks Oy.