File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- #KOACH
2-
3- Production ready boilerplate for building APIs with [ koa2] and mongodb.
1+ ## KOACH
2+ Production ready boilerplate for building APIs with [ koa2] ( https://github.com/koajs/koa/ ) and mongodb.
43
4+ ## Description
55This project covers basic necessities of most APIs.
66* Authentication (passport & jwt)
77* Database (mongoose)
88* Testing (mocha)
99* Doc generation with apidoc
1010* linting using standard
1111
12- ##Requirements
12+ ## Requirements
1313* node > v7.8.0
1414
15- ##Installation
15+ ## Installation
1616``` bash
1717git clone
1818```
1919
20- ##Features
20+ ## Features
2121* [ koa2] ( https://github.com/koajs/koa )
2222* [ koa-router] ( https://github.com/alexmingoia/koa-router )
2323* [ koa-bodyparser] ( https://github.com/koajs/bodyparser )
@@ -32,7 +32,7 @@ git clone
3232* [ Babel] ( https://github.com/babel/babel )
3333* [ ESLint] ( http://eslint.org/ )
3434
35- ##Structure
35+ ## Structure
3636```
3737├── bin
3838│ └── server.js # Bootstrapping and entry point
@@ -54,19 +54,19 @@ git clone
5454└── test # Unit tests
5555```
5656
57- ##Usage
57+ ## Usage
5858* ` npm start ` Start server on live mode
5959* ` npm run dev ` Start server on dev mode with nodemon
6060* ` npm run docs ` Generate API documentation
6161* ` npm test ` Run mocha tests
6262
63- ##Documentation
63+ ## Documentation
6464API documentation is written inline and generated by [ apidoc] ( http://apidocjs.com/ ) .
6565
6666Visit ` http://localhost:3000/docs/ ` to view docs
6767
68- ##Contributors
68+ ## Contributors
6969Systango, Arpit Khandelwal
7070
71- ##License
71+ ## License
7272MIT
You can’t perform that action at this time.
0 commit comments