mirror of
https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer.git
synced 2026-09-21 16:52:03 -07:00
Update readme
This commit is contained in:
@@ -2,10 +2,10 @@
|
||||
Boilerplate for building APIs with [koa2](https://github.com/koajs/koa/tree/v2.x) and mongodb.
|
||||
|
||||
This project covers basic necessities of most APIs.
|
||||
|
||||
* Authentication (passport & jwt)
|
||||
* Database (mongoose)
|
||||
* Testing (mocha)
|
||||
* Doc generation with jsondoc
|
||||
|
||||
##Requirements
|
||||
* node __^4.0.0__
|
||||
@@ -17,7 +17,7 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
|
||||
```
|
||||
|
||||
##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-bodyparser](https://github.com/koajs/bodyparser)
|
||||
* [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/)
|
||||
* [Nodemon](http://nodemon.io/)
|
||||
* [Mocha](https://mochajs.org/)
|
||||
* [jsondoc](http://apidocjs.com/)
|
||||
* [Babel](https://github.com/babel/babel)
|
||||
* [ESLint](https://esling.ord)
|
||||
* [ESLint](http://eslint.org/)
|
||||
|
||||
##Structure
|
||||
```
|
||||
├── bin
|
||||
│ └── server.js # Bootstrapping and entry point
|
||||
├── config # Server configuration settings
|
||||
│ ├── server.js # Bootstrapping and entry point
|
||||
│ ├── config.js # JSON dictionary for environment specific config
|
||||
│ ├── env # 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
|
||||
├── src # Source code
|
||||
│ ├── controllers # Routes
|
||||
@@ -47,7 +54,13 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
|
||||
##Usage
|
||||
* `npm start` Start server on live mode
|
||||
* `npm run dev` Start server on dev mode with nodemon
|
||||
* `npm run docs` Generate API documentation
|
||||
* `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
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user