brijeshbhakta30/node-express-sequelize-starter

This is a boiler plate for NodeJS which uses express and sequelize for database management.

node-express-sequalize-starter

A Boilerplate application for building REST APIs using node, express and SQL databases.

Notes

• commit messages are validated by this convention.
• Airbnb's javascript style guide and eslint config is followed.
• Code depends on .env files and will validate the files to run properly.
• To reflect changes in .env files, a restart will be required.
• Staged files will be fixed for linting error before commit by eslint, husky and lint-staged.

Install dependencies

npm i

To setup the project

• Create an environment file by copying the .env.example file and add respective values.

To run the project in development

npm run dev

For Linting files

npm run lint

Database migration notes:

For creating database migrations

npm run migration:create <migration-name>

For running the database migrations

npm run db:migrate