pickabook-restful-api

restiful api for pick a book wechat mini app A brief description of your project, what it is used for.

Installing / Getting started

To run the project without modifying code just use npm run dev and visit http://localhost:3002 in your browser if you are modifying the code run npm run dev:build to start webpack then run npm run dev running.

npm run dev
npm run dev:build -->starts webpack

Developing

visit /api/v1/apidoc to see the documentation of the routes

Built With

Nodejs,Express

Prerequisites

run npm install to install the dependencies

Setting up Dev

npm run dev:build then npm run dev --> start coding

git clone https://github.com/labirin/pickabook-api.git
cd connect-api/
npm install

Versioning

We can maybe use git and github

Configuration

No extra configurations all set

Tests

TODO

Api Reference

The api works with wechat Oauth for more visit /api/v1/apidoc

Database

Mongodb with mongoose

Licensing

MIT credit and special thanks to my kindest friend : https://github.com/francishero/connect-restiful-api