db3
a Lightweight, Permanent JSON document database
File Explorer
Download Latest Version (.zip)- bug_report.md
- config.yml
- feature_request.md
- cd.yml
- ci.yml
- docker_release_cd.yml
- rust-clippy.yml
- sdk_cd.yml
- sdk_page.yml
- welcome.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- DB3MetaStore.json
- Events.json
- ar_miner.sh
- config.ts
- Dockerfile
- start_localnet.sh
- js_client.md
- terminal_client.md
- mutation.md
- query.md
- query_session.md
- js_demo.md
- community_node.md
- run_locally.md
- data_manager.md
- overview.md
- quick_start.md
- run_node.md
- 986shots_so.jpg
- data_control.png
- data_curd.png
- data_open.png
- data_speed.png
- db3-architecture.svg
- db3-console.png
- db3-contract.svg
- db3-data-ownership.svg
- db3-deploy-contract.svg
- db3-dvm.svg
- db3-mutaion.svg
- db3-offchain-indexing.svg
- db3-onchain-indexing.svg
- db3-overview.svg
- db3-query-sharding.svg
- db3-query.svg
- db3-roadmap.svg
- db3-sharding.svg
- db3-table.svg
- db3_arch.png
- db3_arch.svg
- db3_bills.svg
- db3_data_flow.png
- db3_logo.svg
- db3_network.png
- db3_overview.png
- db3_sdk.png
- db3_sign_mutation.png
- permission.svg
- playground.png
- position_web3.svg
- todo_mvc_db3.png
- why_db3.svg
- dvm.md
- function.md
- merkdb.md
- overview.md
- query_session.md
- features.md
- why_db3.md
- account.md
- account_credit.md
- signiture.md
- collection.md
- database.md
- indexer.md
- record.md
- bills.md
- fee.md
- gas.md
- consensus.md
- event.md
- security.md
- node.md
- overview.md
- .gitignore
- index.md
- index_oldx.md
- white_paper.md
- AddDocResult.java
- Client.java
- CreateCollectonResult.java
- CreateDBResult.java
- EIP712TypedMessage.java
- IndexProvider.java
- StorageProvider.java
- TypedMessage.java
- ResultSet.java
- ClientTest.java
- StorageProviderTest.java
- typed_data.json
- .gitignore
- pom.xml
- README.md
- IDB3MetaStore.sol
- Events.sol
- Types.sol
- DB3MetaStore.sol
- deploy.ts
- deploy_metadata.ts
- db3_metastore_network_create_collection_test.ts
- db3_metastore_network_create_db_test.ts
- db3_metastore_network_register_test.ts
- db3_metastore_network_transfer_database_test.ts
- db3_metastore_network_transfer_network.ts
- db3_metastore_network_update_rollup_node.ts
- db3_metastore_network_update_rollup_steps.ts
- .prettierrc.json
- deploy_mumbai.sh
- deploy_scroll.sh
- deploy_to_local.sh
- hardhat.config.ts
- package.json
- README.md
- start_hardhat_node.sh
- start_localnet.sh
- tsconfig.json
- yarn.lock
- metastore_abi.ts
- db3_account.ts
- types.ts
- sdk_mutation.ts
- base.ts
- client_v2.ts
- types.ts
- crypto_utils.ts
- mnemonics.ts
- publickey.ts
- sig_utils.ts
- .gitkeep
- error.ts
- indexer_provider.ts
- storage_provider_v2.ts
- database_v2.ts
- document_v2.ts
- types.ts
- readable.ts
- index.ts
- react-app-env.d.ts
- quick_started.png
- client_v2.test.ts
- database_v2.test.ts
- provider.test.ts
- query.test.ts
- .prettierrc
- babel.config.json
- format.sh
- jest.config.ts
- jest.setup.ts
- Makefile
- package.json
- README.md
- tsconfig.json
- yarn.lock
- bson_util.rs
- lib.rs
- strings.rs
- test_base.rs
- times.rs
- Cargo.toml
- command.rs
- console.rs
- keystore.rs
- lib.rs
- shell.rs
- Cargo.toml
- db3_address.rs
- id.rs
- id_v2.rs
- lib.rs
- Cargo.toml
- lib.rs
- Cargo.toml
- event_processor.rs
- lib.rs
- meta_store_event_processor.rs
- Cargo.toml
- 37829_37968.gz.parquet
- ar_toolbox.rs
- command.rs
- indexer_impl.rs
- lib.rs
- main.rs
- mutation_utils.rs
- node_test_base.rs
- recover.rs
- rollup_executor.rs
- storage_node_light_impl.rs
- system_impl.rs
- version_util.rs
- build.rs
- Cargo.toml
- db3_base.proto
- db3_database_v2.proto
- db3_indexer.proto
- db3_mutation_v2.proto
- db3_rollup.proto
- db3_storage.proto
- db3_system.proto
- lib.rs
- build.rs
- Cargo.toml
- sdk_benchmark.rs
- submit_mutation_benchmark.rs
- indexer_sdk.rs
- lib.rs
- sdk_test.rs
- store_sdk_v2.rs
- system_sdk.rs
- Cargo.toml
- 37829_37968.gz.parquet
- ar_fs.rs
- collection_key.rs
- db_doc_key_v2.rs
- db_owner_key_v2.rs
- db_store_v2.rs
- doc_key_v2.rs
- doc_store.rs
- key_store.rs
- lib.rs
- meta_store_client.rs
- mutation_store.rs
- state_store.rs
- system_store.rs
- Cargo.toml
- README.md
- arweave-rs
- data-manager
- ar.secret
- evm.secret
- ar_miner.sh
- db3up
- db3up_init.sh
- gen_proto_js.sh
- local_testnet.tar.gz
- start_localnet.sh
- start_localtestnet.sh
- wallet.json
- .gitignore
- .gitmodules
- BUILD.md
- Cargo.toml
- CHANGELOG.md
- clippy.toml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- format.sh
- install_env.sh
- LICENSE
- mkdocs.yml
- README.md
- rustfmt.toml
- tea.yaml
# Installation Guide
1. Get the code
git clone https://github.com/dbpunk-labs/db3
Downloads the entire project code from GitHub to your computer.
cd db3
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
sudo docker run -p 26639:26639 -p 26619:26619 -p 26629:26629 \
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Maven (Java)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java projects.
- Maven The build tool used for the mvn command.
cd java
This project's files live in a subfolder, so move into it first.
mvn clean install
Installs dependencies and builds the project using Maven.
A BUILD SUCCESS message means it worked. The output is created under target/.
4. Node.js
EasyPrerequisites
cd metadata
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
5. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
6. 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).
cd sdk
This project's files live in a subfolder, so move into it first.
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)