@qiibee/qb-api v0.2.0

qiibee API

A NodeJS RESTful API to connect to the qiibee blockchain

Disclaimer: this a PoC of the qiibee API, it's development is a work in progress and may not pass all quality tests. We welcome bug reports and/or contributions

API documentation

Click here to get our documentation

Requirements

• Node v8

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

• Clone the project

git clone https://github.com/qiibee/qb-api.git
cd qb-api

• Edit config

  • Add your infura token in the placeholder in src/config/config.js

• Setup mysql locally

• this has been validated to be working with mysql Ver 8.0.11 for osx10.13 on x86_64 (Homebrew)
• for OSX you can do brew install mysql

• access mysql using the `mysql` program from the terminal

• inside the mysql console type CREATE DATABASE qiibee
• further on you'll be accessing the mysql console using the command mysql -u root --password and leave a blank password

• Start

npm install
# start dependencies locally and an instance of qb-api
npm run localenv launch

Go to localhost:3000

To run a transaction and fetch the history do:

npm localenv seed

License

qiibee API is open source and distributed under the Apache License v2.0