forked from hagopj13/node-express-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |