https://github.com/renanrboliveira/node-api-boilerplate
Node API Boilerplate
https://github.com/renanrboliveira/node-api-boilerplate
babeljs es6 mongodb node
Last synced: 4 months ago
JSON representation
Node API Boilerplate
- Host: GitHub
- URL: https://github.com/renanrboliveira/node-api-boilerplate
- Owner: renanrboliveira
- License: mit
- Created: 2017-09-13T03:26:10.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2021-03-03T18:33:38.000Z (over 5 years ago)
- Last Synced: 2025-10-24T19:33:16.200Z (8 months ago)
- Topics: babeljs, es6, mongodb, node
- Language: JavaScript
- Size: 2.64 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Node API Boilerplate
[](https://travis-ci.org/renanol/node-api-boilerplate)
[](https://coveralls.io/github/renanol/node-api-boilerplate?branch=master)
[](https://greenkeeper.io/)
## Getting Started
Clone the repo and make it yours:
```bash
git clone --depth 1 https://github.com/renanol/node-api-boilerplate && cd node-api-boilerplate
rm -rf .git
```
Install dependencies:
```bash
yarn
```
Set environment variables:
```bash
cp .env.example .env
```
## Running Locally
```bash
yarn dev
```
## Running in Production
```bash
yarn start
```
## Lint
```bash
# lint code with ESLint
yarn lint
# try to fix ESLint errors
yarn lint:fix
# lint and watch for changes
yarn lint:watch
```
## Test
```bash
# run all tests with Mocha
yarn test
# run unit tests
yarn test:unit
# run integration tests
yarn test:integration
# run all tests and watch for changes
yarn test:watch
# open nyc test coverage reports
yarn coverage
```
## Validate
```bash
# run lint and tests
yarn validate
```
## Logs
```bash
# show logs in production
pm2 logs
```
## Documentation
```bash
# generate and open api documentation
yarn docs
```
## Inspirations
- [danielfsousa/express-mongoose-es6-rest-api](https://github.com/danielfsousa/express-rest-es2017-boilerplate)
## License
[MIT License](README.md) - [Renan Oliveira](https://github.com/renanol)