Home Reference Source Test

jungle-db Build Status

JungleDB is a simple database abstraction layer for NodeJS (LevelDB) and Browsers (IndexedDB) supporting advanced features such as transactions with read-isolation and secondary indices.

Quickstart

  1. Clone this repository git clone https://github.com/nimiq-network/jungle-db.
  2. Run npm install or yarn
  3. Run npm run build or yarn build
  4. Open clients/browser/index.html in your browser to access a simple browser example.

Run Example

Run Browser Example

Open clients/browser/index.html in your browser.

Run NodeJs Example

Start the example by running clients/nodejs/index.js.

cd clients/nodejs/
node index.js

API

We're currently annotating all classes and methods to get a complete API documentation.

Benchmarks

Run Browser Benchmarks

Open benchmark/browser/index.html in your browser

Run NodeJs Benchmarks

Start the example by running benchmark/nodejs/index.js.

cd benchmark/nodejs/
node index.js

Developers

Developers are free to choose between npm and yarn for managing the dependencies.

Installation for Core Developers (using npm)

Installation for Core Developers (using yarn)

Test and Build

Run Testsuite

Run ESLint

npm run lint or yarn lint runs the ESLint javascript linter.

Build

Executing npm run build or yarn build concatenates all sources into dist/{web,node}.js

Contribute

If you'd like to contribute to the development of JungleDB please follow our Code of Conduct and Contributing Guidelines.

License

This project is under the Apache License 2.0.