Basic-App-Structure

A template of Node.js Web Server.

Pre requisites

npm install or npm i

npm start

node server | bunyan #install bunyan globally for good formatting of logs

npm run server (hot reloading)

npm run logs

npm run stop

> npm run lint
> npm run prettier

For development, define required variables in development.json
For production, define required variables as environment variable in remote setup.

npm run db:migrate:create migration-name

npm run db:migrate

npm run db:migrate:undo

Every Database Table should have a corresponding Model file in models folder
We use Sequelize as our ORM
Use npx sequelize to cli for migrations
The controllers and routes folder should exactly mimic each other. All routers in routes should have their corresponding controllers file/folder
All logging should be done using req.log. It's a bunyan logger. For model level logging, req.log should be passed to underlying layers