psf/ipfs-bch-wallet-consumer
1
0
Fork 0
mirror of https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer.git synced 2026-09-21 16:52:03 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Adrian Obelmejias
2016-03-04 23:58:22 -05:00
parent e96606acdb
commit 67455677d7
1 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -5
View File
@@ -2,10 +2,10 @@
Boilerplate for building APIs with [koa2](https://github.com/koajs/koa/tree/v2.x) and mongodb. Boilerplate for building APIs with [koa2](https://github.com/koajs/koa/tree/v2.x) and mongodb.
This project covers basic necessities of most APIs. This project covers basic necessities of most APIs.
* Authentication (passport & jwt) * Authentication (passport & jwt)
* Database (mongoose) * Database (mongoose)
* Testing (mocha) * Testing (mocha)
* Doc generation with jsondoc
##Requirements ##Requirements
* node __^4.0.0__ * node __^4.0.0__
@@ -17,7 +17,7 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
``` ```
##Features ##Features
* [Koa](https://github.com/koajs/koa/tree/v2.x) * [koa2](https://github.com/koajs/koa/tree/v2.x)
* [koa-router](https://github.com/alexmingoia/koa-router) * [koa-router](https://github.com/alexmingoia/koa-router)
* [koa-bodyparser](https://github.com/koajs/bodyparser) * [koa-bodyparser](https://github.com/koajs/bodyparser)
* [koa-generic-session](https://github.com/koajs/generic-session) * [koa-generic-session](https://github.com/koajs/generic-session)
@@ -27,14 +27,21 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
* [Passport](http://passportjs.org/) * [Passport](http://passportjs.org/)
* [Nodemon](http://nodemon.io/) * [Nodemon](http://nodemon.io/)
* [Mocha](https://mochajs.org/) * [Mocha](https://mochajs.org/)
* [jsondoc](http://apidocjs.com/)
* [Babel](https://github.com/babel/babel) * [Babel](https://github.com/babel/babel)
* [ESLint](https://esling.ord) * [ESLint](http://eslint.org/)
##Structure ##Structure
``` ```
├── bin
│ └── server.js # Bootstrapping and entry point
├── config # Server configuration settings ├── config # Server configuration settings
│ ├── server.js # Bootstrapping and entry point │ ├── env # Environment specific config
│ ├── config.js # JSON dictionary for environment specific config │ │ ├── common.js
│ │ ├── development.js
│ │ ├── production.js
│ │ └── test.js
│ ├── index.js # Config entrypoint - exports config according to envionrment and commons
│ └── passport.js # Passportjs config of strategies │ └── passport.js # Passportjs config of strategies
├── src # Source code ├── src # Source code
│ ├── controllers # Routes │ ├── controllers # Routes
@@ -47,7 +54,13 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
##Usage ##Usage
* `npm start` Start server on live mode * `npm start` Start server on live mode
* `npm run dev` Start server on dev mode with nodemon * `npm run dev` Start server on dev mode with nodemon
* `npm run docs` Generate API documentation
* `npm test` Run mocha tests * `npm test` Run mocha tests
##Documentation
API documentation is written inline and generated by [jsondoc](http://apidocjs.com/).
Visit `http://localhost:5000/docs/` to view docs
##License ##License
MIT MIT