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.
Funding
OrbitDB is currently funded by OpenCollective. Please visit our page there to learn more.
Installation
The quickest way to get started with OrbitDB is to install the core module:
npm i @orbitdb/coreRepositories 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.
Code-free repositories
Awesome OrbitDB, which is an attempt to list everything that is using OrbitDB, or could help people. Basically, what has been built?
OrbitDB
OrbitDB Core - The main repo for OrbitDB.
There are also 3rd party modules which are officially developed by OrbitDB. It should be noted that all of these are JavaScript modules on npm.
Ethereum Identity Provider - An Ethereum-based identity provider for OrbitDB.
DID Identity Provider - A Decentralized IDentitifer identity provider for OrbitDB.
Implementations
A Go implementation is developed and maintained by the Berty project at berty/go-orbit-db.
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!
Press
Materials for press (logos, formats, guidelines, etc) are available here. For interviews etc, reach out to @aphelionz on Twitter.
Other repositories?
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.
Registries
We maintain OrbitDB accounts on these registries:
Contribute
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 maintained by @RichardLitt. If you've got any questions for him, feel free to open an issue or a pull request, or to email him privately. we're always looking for more maintainers!
License
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.
