mirror of
https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer.git
synced 2026-09-21 16:52:03 -07:00
1eae3a4c0ebf4ca9344c59ef40c067baf925a56e
#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)
##Requirements
- node ^4.0.0
- npm ^3.0.0
##Installation
git clone https://github.com/adrianObel/koa2-api-boilerplate.git
##Features
- Koa
- koa-router
- koa-bodyparser
- koa-generic-session
- koa-logger
- MongoDB
- Mongoose
- Passport
- Nodemon
- Mocha
- Babel
- ESLint
##Structure
├── config # Server configuration settings
│ ├── server.js # Bootstrapping and entry point
│ ├── config.js # JSON dictionary for environment specific config
│ └── passport.js # Passportjs config of strategies
├── src # Source code
│ ├── controllers # Routes
│ ├── models # Mongoose models
│ └── middleware # Custom middleware
│ └── validators # Validation middleware
└── test # Unit tests
##Usage
npm startStart server on live modenpm run devStart server on dev mode with nodemonnpm testRun mocha tests
##License MIT
Languages
JavaScript
98.2%
Shell
0.7%
HTML
0.7%
Dockerfile
0.4%