0.0.7 • Published 6 years ago

qb-api v0.0.7

Weekly downloads
-
License
ISC
Repository
-
Last release
6 years ago

npm.io

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

Build Status

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
  • next type ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'a12345678$X'
  • further on you'll be accessing the mysql console using the command mysql -u root --password and type in the above password
  • Start
npm install
# start dependencies locally and an instance of qb-api
npm run localdev launch

Go to localhost:3000

To run a transaction and fetch the history do:

npm localdev seed

License

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