https://github.com/wearepush/learn-redux-task4-backend
https://github.com/wearepush/learn-redux-task4-backend
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/wearepush/learn-redux-task4-backend
- Owner: wearepush
- License: mit
- Created: 2019-12-16T17:47:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T00:58:18.000Z (over 3 years ago)
- Last Synced: 2025-10-14T21:36:11.012Z (9 months ago)
- Language: JavaScript
- Size: 2.06 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# node-express-mongoose-starter
A Boilerplate application for building REST APIs using node, express and mongoose
## Notes
- commit messages are validated by [this](https://www.conventionalcommits.org) convention.
- [Airbnb's javascript style guide](https://github.com/airbnb/javascript) and [eslint config](https://www.npmjs.com/package/eslint-config-airbnb-base) 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](https://eslint.org/), [husky](https://www.npmjs.com/package/husky) and [lint-staged](https://www.npmjs.com/package/lint-staged).
### Install dependencies
```sh
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
```sh
npm run dev
```
### Tests:
##### For Test cases
```sh
npm run test
```
##### For Linting files
```sh
npm run lint
```
##### For Code Coverage
```sh
npm run test:coverage
```
Mongo
```sh
brew services start mongodb
```