https://github.com/emilioriosvz/express-boilerplate
🚀 Starter project for a RESTful API in Node with Express & mongoose component-based
https://github.com/emilioriosvz/express-boilerplate
boilerplate component-architecture eslint express jwt-authentication mongodb mongoose nodejs rest-api standard-js template yarn
Last synced: 11 months ago
JSON representation
🚀 Starter project for a RESTful API in Node with Express & mongoose component-based
- Host: GitHub
- URL: https://github.com/emilioriosvz/express-boilerplate
- Owner: emilioriosvz
- Created: 2017-01-13T20:42:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T04:00:59.000Z (over 3 years ago)
- Last Synced: 2025-07-06T23:06:55.075Z (about 1 year ago)
- Topics: boilerplate, component-architecture, eslint, express, jwt-authentication, mongodb, mongoose, nodejs, rest-api, standard-js, template, yarn
- Language: JavaScript
- Homepage:
- Size: 148 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Express & mongoose REST API Boilerplate component based
[](http://makeapullrequest.com)
[](https://codeclimate.com/github/emilioriosvz/express-boilerplate)
[](http://standardjs.com/)
## Getting Started
Clone the repo:
```sh
git clone git@github.com:emilioriosvz/express-boilerplate.git
cd express-boilerplate
```
Install yarn:
```js
npm install -g yarn
```
Install dependencies:
```sh
yarn
```
## Run the project in docker
Build the image:
```sh
docker build -t /express-boilerplate .
```
If the image was created correctly, you can see it doing:
```js
docker images
```
Run the image:
```sh
docker run -p 3000:3000 -d --name express-boilerplate /express-boilerplate
```
## Features
* Authentication via JsonWebToken
* Secure app via helmet
* Uses [yarn](https://yarnpkg.com) instead of npm
* Uses [StandardJS](https://github.com/feross/standard) as style guide
* Promises via [Bluebird](http://bluebirdjs.com/docs/getting-started.html)
* API parameter validation via [express-validation](https://github.com/ctavan/express-validator) using [Joi](https://github.com/hapijs/joi)
## Todo list
If you like what you see, there are some tasks that would have to be done:
* Add testing
* Add code coverage
* Add eslint
* Add logger
## Contributing
Contributions, questions and comments are all welcome.🤘