orbitdb
Peer-to-Peer Databases for the Decentralized Web
File Explorer
Download Latest Version (.zip)- api-publish.yml
- npm-publish-next.yml
- npm-publish.yml
- run-test-node-min-ver.yml
- run-test.yml
- FUNDING.yml
- funding-manifest-urls
- benchmark-add.html
- benchmark-replication-sender.html
- benchmark-replication.html
- log-append.js
- log-iterator.js
- orbitdb-documents.js
- orbitdb-events.js
- orbitdb-keyvalue.js
- orbitdb-kv-indexed.js
- orbitdb-replicate.js
- jsdoc.json
- layout.tmpl
- webpack.config.js
- webpack.debug.config.js
- webpack.tests.config.js
- README.md
- ACCESS_CONTROLLERS.md
- CONNECTING_PEERS.md
- DATABASES.md
- ENCRYPTION.md
- GETTING_STARTED.md
- IDENTITIES.md
- OPLOG.md
- REPLICATION.md
- STORAGE.md
- orbit_db_logo_color.jpg
- orbit_db_logo_color.png
- index.js
- ipfs.js
- orbitdb.js
- documents.js
- events.js
- index.js
- keyvalue-indexed.js
- keyvalue.js
- index.js
- publickey.js
- identities.js
- identity.js
- index.js
- clock.js
- conflict-resolution.js
- entry.js
- heads.js
- index.js
- log.js
- oplog-store.js
- composed.js
- index.js
- ipfs-block.js
- level.js
- lru.js
- memory.js
- create-id.js
- index.js
- path-join.js
- address.js
- database.js
- index.js
- key-store.js
- manifest-store.js
- orbitdb.js
- sync.js
- .mocharc.json
- ipfs-access-controller.test.js
- orbit-db-access-controller.test.js
- index.html
- setup-fixtures.js
- documents.test.js
- events.test.js
- keyvalue-indexed.test.js
- keyvalue.test.js
- documents.test.js
- events.test.js
- keyvalue-indexed.js
- keyvalue.test.js
- 001232.ldb
- 001274.log
- CURRENT
- LOCK
- LOG
- LOG.old
- MANIFEST-001273
- custom.js
- fake.js
- no-type.js
- no-verify-identity.js
- big-log.fixture.js
- providers.js
- test-keys-path.js
- identities.test.js
- identity.test.js
- log-creator.js
- append.test.js
- clock.test.js
- conflict-resolution.test.js
- crdt.test.js
- entry.test.js
- heads.test.js
- iterator.test.js
- join-concurrent.test.js
- join.test.js
- load.test.js
- log.test.js
- references.test.js
- replicate.test.js
- signed-log.test.js
- ipfs-block.test.js
- connect-nodes.js
- create-helia.js
- relay.js
- wait-for-peers.js
- wait-for.js
- .mocharc.json
- database-replication.test.js
- database.test.js
- key-store.test.js
- manifest-store.test.js
- orbit-db-address.test.js
- orbitdb-access-controllers.test.js
- orbitdb-custom-database-types.test.js
- orbitdb-custom-identity-providers.test.js
- orbitdb-drop.test.js
- orbitdb-encryption.test.js
- orbitdb-multiple-databases.test.js
- orbitdb-open.test.js
- orbitdb-replication.test.js
- orbitdb-write-access.test.js
- orbitdb.test.js
- path-join.spec.js
- storage.test.js
- sync.test.js
- .gitignore
- .npmignore
- .nvmrc
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- CONTRIBUTORS.md
- LICENSE
- Makefile
- package-lock.json
- package.json
- README.md
๐ Installation Guide
1. Get the code
git clone https://github.com/orbitdb/orbitdb
Downloads the entire project code from GitHub to your computer.
cd orbitdb
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install @orbitdb/core helia
Downloads and installs the libraries listed in package.json.
npm run test
Type this command into your terminal and run it.
npm run build
Builds optimized production files.
npm run build:docs
Builds optimized production files.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
3. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)