This commit is contained in:
Adrian Obelmejias
2016-08-30 15:27:07 -04:00
parent 475d847839
commit 945ae3e6c2
+3 -3
View File
@@ -5,7 +5,7 @@ This project covers basic necessities of most APIs.
* Authentication (passport & jwt)
* Database (mongoose)
* Testing (mocha)
* Doc generation with jsondoc
* Doc generation with apidoc
##Requirements
* node __^4.0.0__
@@ -27,7 +27,7 @@ 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/)
* [apidoc](http://apidocjs.com/)
* [Babel](https://github.com/babel/babel)
* [ESLint](http://eslint.org/)
@@ -60,7 +60,7 @@ git clone https://github.com/adrianObel/koa2-api-boilerplate.git
* `npm test` Run mocha tests
##Documentation
API documentation is written inline and generated by [jsondoc](http://apidocjs.com/).
API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
Visit `http://localhost:5000/docs/` to view docs