- NodeJS boilerplate on top of express without the need to use Babel
- ExpressJS - NodeJS HTTP Framework
- Sequelize - NodeJS ORM
- Mogran - Express logger
- Winston - Logs transport to console/file. Logrotate daily added
- dotenv-safe - environment manager
- MochaJS - Testing framework
- Eslint - Base:AirBnB
- Swagger - Define/Document APIs
and more
- NodeJS v7.0+
- Yarn
- Docker, docker compose/swarm for prod to maximize nginx caching & security(optional)
$ git clone https://github.com/shierro/node-express-boilerplate <project_name>
$ cd <project_name> && npm i
$ cp .env.example .env
Change .env vars with your env
$ yarn dev
$ yarn test
$ yarn run cover
$ docker-compose up -d
$ yarn generate:models
- http://localhost:<PORT_IN_ENV>/healthcheck
- http://localhost:<PORT_IN_ENV>/version
- http://localhost:<PORT_IN_ENV>/specs