node-express-mongoose-starter
A Boilerplate application for building REST APIs using node, express and mongoose
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 environment files according to environment like
.env.development
by copying the.env.example
file and add respective values. Create one for each environment.
To run the project in development
npm run dev
Tests:
For Test cases
npm run test
For Linting files
npm run lint
For Code Coverage
npm run test:coverage
Mongo
brew services start mongodb