mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-05-21 06:16:38 +00:00
213 lines
8.4 KiB
Markdown
213 lines
8.4 KiB
Markdown
# orbit-db
|
|
|
|
[](http://webchat.freenode.net/?channels=%23orbitdb)
|
|
[](https://circleci.com/gh/orbitdb/orbit-db)
|
|
[](https://www.npmjs.com/package/orbit-db)
|
|
[](https://www.npmjs.com/package/orbit-db)
|
|
[](https://waffle.io/orbitdb/orbit-db)
|
|
|
|
> A peer-to-peer database for the decentralized web
|
|
|
|
`orbit-db` is a serverless, distributed, peer-to-peer database. `orbit-db` uses [IPFS](https://ipfs.io) as its data storage and [IPFS Pubsub](https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go#L23) to automatically sync databases with peers. It's an eventually consistent database that uses [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) for conflict-free database merges making `orbit-db` an excellent choice for decentralized apps (dApps), blockchain applications and offline-first web applications.
|
|
|
|
Data in `orbit-db` can be stored in a
|
|
|
|
- **[Key-Value Store](https://github.com/orbitdb/orbit-db/blob/master/API.md#keyvaluenameaddress)**
|
|
- **[Log Database](https://github.com/orbitdb/orbit-db/blob/master/API.md#lognameaddress)** (append-only log)
|
|
- **[Feed](https://github.com/orbitdb/orbit-db/blob/master/API.md#feednameaddress)** (same as log database but entries can be removed)
|
|
- **[Document Store](https://github.com/orbitdb/orbit-db/blob/master/API.md#docsnameaddress-options)** (store indexed JSON documents)
|
|
- **[Counters](https://github.com/orbitdb/orbit-db/blob/master/API.md#counternameaddress)**
|
|
|
|
This is the Javascript implementation and it works both in **Node.js** and **Browsers**.
|
|
|
|
To get started, try the **[OrbitDB CLI](https://github.com/orbitdb/orbit-db-cli)**, read the **[Getting Started Guide](https://github.com/orbitdb/orbit-db/blob/master/GUIDE.md)** or check **[Live demo 1](https://ipfs.io/ipfs/QmRosp97r8GGUEdj5Wvivrn5nBkuyajhRXFUcWCp5Zubbo/)**, **[Live demo 2](https://ipfs.io/ipfs/QmasHFRj6unJ3nSmtPn97tWDaQWEZw3W9Eh3gUgZktuZDZ/)** or **[P2P TodoMVC app](https://ipfs.io/ipfs/QmTJGHccriUtq3qf3bvAQUcDUHnBbHNJG2x2FYwYUecN43/)**!
|
|
|
|
<p align="left">
|
|
<img src="https://raw.githubusercontent.com/orbitdb/orbit-db/feat/write-access/screenshots/example1.png" width="28%">
|
|
<a href="https://asciinema.org/a/JdTmmdBCZarkBkPqbueicwMrG" target="_blank"><img src="https://asciinema.org/a/JdTmmdBCZarkBkPqbueicwMrG.png" width="50%"/></a>
|
|
</p>
|
|
|
|
## Table of Contents
|
|
|
|
- [Usage](#usage)
|
|
- [API](#api)
|
|
- [Examples](#examples)
|
|
- [Development](#development)
|
|
- [Background](#background)
|
|
- [Contributing](#contributing)
|
|
- [License](#license)
|
|
|
|
## Usage
|
|
|
|
Read the **[GETTING STARTED](https://github.com/orbitdb/orbit-db/blob/master/GUIDE.md)** guide for a more in-depth tutorial and to understand how OrbitDB works.
|
|
|
|
### CLI
|
|
|
|
For the CLI tool to manage orbit-db database, see **[OrbitDB CLI](https://github.com/orbitdb/orbit-db-cli)**.
|
|
|
|
It can be installed from Npm with:
|
|
|
|
```
|
|
npm install orbit-db-cli -g
|
|
```
|
|
|
|
### As a library
|
|
|
|
Install dependencies:
|
|
|
|
```
|
|
npm install orbit-db ipfs
|
|
```
|
|
|
|
Use it as a module:
|
|
|
|
```javascript
|
|
const IPFS = require('ipfs')
|
|
const OrbitDB = require('orbit-db')
|
|
|
|
// OrbitDB uses Pubsub which is an experimental feature
|
|
// and need to be turned on manually.
|
|
// Note that these options need to be passed to IPFS in
|
|
// all examples even if not specfied so.
|
|
const ipfsOptions = {
|
|
EXPERIMENTAL: {
|
|
pubsub: true
|
|
},
|
|
}
|
|
|
|
// Create IPFS instance
|
|
const ipfs = new IPFS(ipfsOptions)
|
|
|
|
ipfs.on('error', (e) => console.error(e))
|
|
ipfs.on('ready', async () => {
|
|
// Create a database
|
|
const orbitdb = new OrbitDB(ipfs)
|
|
const db = await orbitdb.log('database name')
|
|
// Add an entry to the database
|
|
const hash = await db.add('hello world')
|
|
// Get last 5 entries
|
|
const latest = db.iterator({ limit: 5 }).collect()
|
|
console.log(JSON.stringify(latest, null, 2))
|
|
})
|
|
```
|
|
|
|
*For more details, see examples for [kvstore](https://github.com/orbitdb/orbit-db-kvstore#usage), [eventlog](https://github.com/haadcode/orbit-db-eventstore#usage), [feed](https://github.com/haadcode/orbit-db-feedstore#usage), [docstore](https://github.com/shamb0t/orbit-db-docstore#usage) and [counter](https://github.com/haadcode/orbit-db-counterstore#usage).*
|
|
|
|
## API
|
|
|
|
See [API documentation](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbit-db-api-documentation) for the full documentation.
|
|
|
|
- [Getting Started](https://github.com/orbitdb/orbit-db/blob/master/API.md#getting-started)
|
|
- [OrbitDB](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdb)
|
|
- [keyvalue](https://github.com/orbitdb/orbit-db/blob/master/API.md#keyvaluenameaddress)
|
|
- [log](https://github.com/orbitdb/orbit-db/blob/master/API.md#lognameaddress)
|
|
- [feed](https://github.com/orbitdb/orbit-db/blob/master/API.md#feednameaddress)
|
|
- [docstore](https://github.com/orbitdb/orbit-db/blob/master/API.md#docsnameaddress-options)
|
|
- [counter](https://github.com/orbitdb/orbit-db/blob/master/API.md#counternameaddress)
|
|
- [common](https://github.com/orbitdb/orbit-db/blob/master/API.md#store)
|
|
|
|
## Examples
|
|
|
|
### Install dependencies
|
|
|
|
```
|
|
git clone https://github.com/orbitdb/orbit-db.git
|
|
cd orbit-db
|
|
npm install
|
|
```
|
|
|
|
### Browser example
|
|
|
|
```
|
|
npm run build
|
|
npm run examples:browser
|
|
```
|
|
|
|
<p align="left">
|
|
<img src="https://raw.githubusercontent.com/orbitdb/orbit-db/feat/write-access/screenshots/example1.png" width="33%">
|
|
</p>
|
|
|
|
Check the code in [examples/browser/browser.html](https://github.com/orbitdb/orbit-db/blob/master/examples/browser/browser.html) and try the [live example](https://ipfs.io/ipfs/QmRosp97r8GGUEdj5Wvivrn5nBkuyajhRXFUcWCp5Zubbo/).
|
|
|
|
### Node.js example
|
|
|
|
```
|
|
npm run examples:node
|
|
```
|
|
|
|
<img src="https://raw.githubusercontent.com/orbitdb/orbit-db/feat/ipfs-pubsub/screenshots/orbit-db-demo3.gif" width="66%">
|
|
|
|
**Eventlog**
|
|
|
|
See the code in [examples/eventlog.js](https://github.com/orbitdb/orbit-db/blob/master/examples/eventlog.js) and run it with:
|
|
```
|
|
node examples/eventlog.js
|
|
```
|
|
|
|
More examples at [examples](https://github.com/orbitdb/orbit-db/tree/master/examples).
|
|
|
|
## Development
|
|
|
|
#### Run Tests
|
|
```
|
|
npm test
|
|
```
|
|
|
|
#### Build
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
#### Benchmark
|
|
```
|
|
node benchmarks/benchmark-add.js
|
|
```
|
|
|
|
See [benchmarks/]() for more benchmarks.
|
|
|
|
#### Logging
|
|
|
|
To enable OrbitDB's logging output, set a global ENV variable called `LOG` to `debug`,`warn` or `error`:
|
|
|
|
```
|
|
LOG=debug node <file>
|
|
```
|
|
|
|
## Background
|
|
|
|
Uses the following modules:
|
|
|
|
- [ipfs-log](https://github.com/orbitdb/ipfs-log)
|
|
- [crdts](https://github.com/orbitdb/crdts)
|
|
- [orbit-db-cache](https://github.com/orbitdb/orbit-db-cache)
|
|
- [orbit-db-store](https://github.com/orbitdb/orbit-db-store)
|
|
- [orbit-db-eventstore](https://github.com/orbitdb/orbit-db-eventstore)
|
|
- [orbit-db-feedstore](https://github.com/orbitdb/orbit-db-feedstore)
|
|
- [orbit-db-kvstore](https://github.com/orbitdb/orbit-db-kvstore)
|
|
- [orbit-db-docstore](https://github.com/orbitdb/orbit-db-docstore)
|
|
- [orbit-db-counterstore](https://github.com/orbitdb/orbit-db-counterstore)
|
|
- [orbit-db-pubsub](https://github.com/orbitdb/orbit-db-pubsub)
|
|
- [orbit-db-keystore](https://github.com/orbitdb/orbit-db-keystore)
|
|
- [ipfs](https://github.com/ipfs/js-ipfs)
|
|
- [ipfs-pubub-room](https://github.com/ipfs-shipyard/ipfs-pubsub-room)
|
|
|
|
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/.
|
|
|
|
## Contributing
|
|
|
|
We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on IRC [#orbitdb](http://webchat.freenode.net/?channels=%23orbitdb) on Freenode, or in the comments of the [issues section](https://github.com/orbitdb/orbit-db/issues).
|
|
|
|
A good place to start are the issues labelled ["help wanted"](https://github.com/orbitdb/orbit-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc) or the project's [status board](https://waffle.io/orbitdb/orbit-db).
|
|
|
|
## Sponsors
|
|
|
|
The development of OrbitDB has been sponsored by:
|
|
|
|
* [Protocol Labs](https://protocol.ai/)
|
|
|
|
If you want to sponsor developers to work on OrbitDB, please reach out to @haadcode.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) ©️ 2017 Haadcode
|