A node api seed project.
Wiki: https://github.com/xiaozhongliu/node-api-seed/wiki
This repo is not maintained any more, please move your step to the new typescript repo: 🎉 ts-api-seed 🎉
| Aspect | Tech |
|---|---|
| web fx | express |
| task | node-schedule |
| db postgres | sequelize |
| db mongodb | mongoose |
| memcache | node_redis |
| http client | axios |
| logger | log4js-node |
| mailer | nodemailer |
| jwt auth | jsonwebtoken |
| validation | express-validator |
| async flow | async/await of ES7 |
| test fx | jest |
| dashboard | express-status-monitor |
| log auth | http-auth |
| js checker | eslint |
| proc mana | pm2 |
Elaborate api request log into files.
Flexible declarative request validation.
Request log online view behind http auth.
Server status monitor dashboard behind http auth.
Ready made api samples with jwt and latest js features.
Centralized system level config & messages management.
Elaborate api test: test samples & ready made debug config.
Reasonable multi-env config merging mechanism.
Definite DRY, SRP, AOP, ES6/ES7, OCD, etc.
cnpm i # install all packages for dev env
npm t # run api tests written on the basis of jest
npm start # run service in dev env, or hit F5 to debug in vsc
npm run pm2start # host via pm2 in prod env
npm run pm2startqa # host via pm2 in qa env
npm run pm2starttest # host via pm2 in test env
npm run pm2restart # restart hosted service in prod env
npm run pm2restartqa # restart hosted service in qa env
npm run pm2restarttest # restart hosted service in test env
npm run pm2stop # hang up hosted service
npm run pm2delete # remove hosted service