orbitdb/orbit-db

LTS versions (even numbered versions 8, 10, etc) are preferred.To use with older versions of Node.js, we provide an ES5-compatible build through the npm package, located in dist/es5/ when installed through npm.We also have regular community calls, which we announce in the issues in the @orbitdb welcome repository. Join us!Read the GETTING STARTED guide for a quick tutorial on how to use OrbitDB.For a more in-depth tutorial and exploration of OrbitDB's architecture, please check out the OrbitDB Field Manual.For the CLI tool to manage orbit-db database, see OrbitDB CLI.It can be installed from npm with:If you're using orbit-db to develop browser or Node.js applications, use it as a module with the javascript instance of IPFSInstall dependencies:Alternatively, you can use ipfs-api to use orbit-db with a locally running IPFS daemon. There is also a workshop you can follow, which shows how to build an app, at orbit-db/web3-workshop.More examples at examples.OrbitDB uses the following modules:To understand a little bit about the architecture, check out a visualization of the data flow at https://github.com/haadcode/proto2 or a live demo: http://celebdil.benet.ai:8080/ipfs/Qmezm7g8mBpWyuPk6D84CNcfLKJwU6mpXuEN5GJZNkX3XK/.Community-maintained Typescript typings are available here: https://github.com/orbitdb/orbit-db-typesSee benchmarks/ for more benchmarks.To enable OrbitDB's logging output, set a global ENV variable called LOG to debug,warn or error:We have an FAQ!