Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hagopj13 committed Oct 26, 2019
1 parent ee83aa8 commit d5a9862
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# RESTful API Node Server Boilerplate

A boilerplate/starter project for quickly building production-ready RESTful APIs using Node.js, Express, and Mongoose.

It comes with many built-in features, such as authentication using JWT, request validation, unit and integration tests, continuous integration, docker support, etc. For more details about the features, check the list below.

## Features

- Latest ECMAScript features
- [Express](http://expressjs.com)
- [MongoDB](https://www.mongodb.com) object data modeling using [Mongoose](https://mongoosejs.com)
- Dependency management with [Yarn](https://yarnpkg.com)
- Environment variables using [dotenv](https://github.com/motdotla/dotenv) and [cross-env](https://github.com/kentcdodds/cross-env#readme)
- Git hooks with [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged)
- Linting with [ESLint](https://eslint.org) and [Prettier](https://prettier.io)
- Consistent editor configuration using [EditorConfig](https://editorconfig.org)

## License

[MIT](LICENSE)

0 comments on commit d5a9862

Please sign in to comment.