开源软件名称:adrianObel/koa2-api-boilerplate
开源软件地址:https://github.com/adrianObel/koa2-api-boilerplate
开源编程语言:
JavaScript
100.0%
开源软件介绍:#koa2-api-boilerplate
Boilerplate for building APIs with koa2 and mongodb.
This project covers basic necessities of most APIs.
- Authentication (passport & jwt)
- Database (mongoose)
- Testing (mocha)
- Doc generation with apidoc
- linting using standard
##Requirements
##Installation
git clone https://github.com/adrianObel/koa2-api-boilerplate.git
##Features
##Structure
├── bin
│ └── server.js # Bootstrapping and entry point
├── config # Server configuration settings
│ ├── 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
│ ├── modules
│ │ ├── controller.js # Module-specific controllers
│ │ └── router.js # Router definitions for module
│ ├── models # Mongoose models
│ └── middleware # Custom middleware
│ └── validators # Validation middleware
└── test # Unit tests
##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 apidoc.
Visit http://localhost:5000/docs/ to view docs
##License
MIT
|
请发表评论