BitDB Web API Microservice
Clone or download
Pull request Compare This branch is 6 commits ahead of SpendBCH:master.
Latest commit 8c66ee9 Jan 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
public Add favicon. Jan 7, 2019
views Merge branch 'master' into add-logo Jan 7, 2019
.gitignore Initial commit Nov 3, 2018
Dockerfile Dockerfile & pm2 process Dec 24, 2018
README.md updated links + version Jan 11, 2019
bitserve.json updated version Jan 11, 2019
index.js fix merge Dec 26, 2018
package-lock.json Add Bitcoin.com logo. Jan 7, 2019
package.json merge squashed history to fix existing deployments Dec 26, 2018
process.json Dockerfile & pm2 process Dec 24, 2018

README.md

bitserve

Bitdb Microservice

An API Endpoint + Web Query UI for BitDB

How it works

This project contains:

  1. BitDB Microservice API Endpoint: An HTTP API Endpoint to your BitDB
  2. BitDB Query Web UI: As seen in https://bitdb.bitcoin.com/explorer

1. BitDB Microservice API Endpoint

Make HTTP requests to your bitdb node

api

2. BitDB Query Web UI

Makes use of the API endpoint to render the query UI

query

Prerequisites

You must have the following installed.

  1. Bitcoin Full Node: Any BCH node implementation
  2. Bitdb Node: Bitdb is a universal bitcoin database that autonomously synchronizes with Bitcoin https://bitdb.bitcoin.com

Install

Step 1. Clone this repository

git clone https://github.com/Bitcoin-com/bitserve.git

Step 2. Install Dependencies

npm install

Step 3. Install node-jq binary

cd node_modules/node-jq
npm run install-binary

Step 4. Run

npm start

Configure

You can configure the service through bitserve.json

Example:

{
  "query": {
    "v": 3,
    "q": { "find": {}, "limit": 10 }
  },
  "port": 3000,
  "url": "mongodb://localhost:27017",
  "timeout": 30000,
  "log": false,
}

Here's what each attribute represents:

  • query: The default bitdb query to show up when you navigate to /explorer web UI
  • port: web service port
  • url: Mongodb URL that hosts BitDB.
  • timeout: default timeout for all query requests
  • log: true to see request and response logs, false to hide logs