Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/equimper/nodejs-api-boilerplate

A boilerplate for kickstart your nodejs api project with JWT Auth and some new Techs :)
https://github.com/equimper/nodejs-api-boilerplate

boilerplate docker docker-compose es6 es7 eslint express javascript joy lint-staged mongodb mongoose node-js nodejs-api-boilerplate nodejs-boilerplate nps prettier raven raven-log

Last synced: 3 days ago
JSON representation

A boilerplate for kickstart your nodejs api project with JWT Auth and some new Techs :)

Host: GitHub
URL: https://github.com/equimper/nodejs-api-boilerplate
Owner: EQuimper
License: mit
Created: 2017-04-22T15:10:30.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-01-23T19:27:20.000Z (almost 2 years ago)
Last Synced: 2025-01-10T22:12:30.249Z (10 days ago)
Topics: boilerplate, docker, docker-compose, es6, es7, eslint, express, javascript, joy, lint-staged, mongodb, mongoose, node-js, nodejs-api-boilerplate, nodejs-boilerplate, nps, prettier, raven, raven-log
Language: JavaScript
Homepage:
Size: 1.97 MB
Stars: 464
Watchers: 17
Forks: 120
Open Issues: 90
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![forthebadge](http://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/as-seen-on-tv.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/fuck-it-ship-it.svg)](http://forthebadge.com)

---

[![Code Climate](https://img.shields.io/codeclimate/github/EQuimper/nodejs-api-boilerplate.svg?style=flat-square)](https://codeclimate.com/github/EQuimper/nodejs-api-boilerplate)

[![Coverage Status](https://img.shields.io/coveralls/EQuimper/nodejs-api-boilerplate/master.svg?style=flat-square)](https://coveralls.io/github/EQuimper/nodejs-api-boilerplate?branch=master)

[![Build Status](https://img.shields.io/travis/EQuimper/nodejs-api-boilerplate/master.svg?style=flat-square)](https://travis-ci.org/EQuimper/nodejs-api-boilerplate)

[![CircleCI](https://circleci.com/gh/EQuimper/nodejs-api-boilerplate.svg?&style=shield)](https://circleci.com/gh/EQuimper/nodejs-api-boilerplate)

[![Greenkeeper badge](https://badges.greenkeeper.io/EQuimper/nodejs-api-boilerplate.svg)](https://greenkeeper.io/)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![MIT License](https://img.shields.io/npm/l/stack-overflow-copy-paste.svg?style=flat-square)](http://opensource.org/licenses/MIT)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![Dependency Status](https://dependencyci.com/github/EQuimper/nodejs-api-boilerplate/badge)](https://dependencyci.com/github/EQuimper/nodejs-api-boilerplate)

[![dependencies Status](https://david-dm.org/equimper/nodejs-api-boilerplate/status.svg?style=flat-square)](https://david-dm.org/equimper/nodejs-api-boilerplate)

[![devDependencies Status](https://david-dm.org/equimper/nodejs-api-boilerplate/dev-status.svg?style=flat-square)](https://david-dm.org/equimper/nodejs-api-boilerplate?type=dev)

[![nps](https://img.shields.io/badge/scripts%20run%20with-nps-blue.svg?style=flat-square)](https://github.com/kentcdodds/nps)

[![code style equimper](https://img.shields.io/badge/code%20style-equimper-blue.svg?style=flat-square)](https://github.com/EQuimper/eslint-config-equimper)

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)

# NodeJS-API-Boilerplate

[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/powered-by-water.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/powered-by-netflix.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/winter-is-coming.svg)](http://forthebadge.com)

# Always in progress 👷‍

# Get Started

- [Installation](https://github.com/EQuimper/nodejs-api-boilerplate#installation)

- [Install Mongodb](https://github.com/EQuimper/nodejs-api-boilerplate#install-mongodb)

- [Raven Log](https://github.com/EQuimper/nodejs-api-boilerplate#raven-log)

- [Body Whitelist](https://github.com/EQuimper/nodejs-api-boilerplate#body-whitelist)

- [Api Doc](https://github.com/EQuimper/nodejs-api-boilerplate#api-doc)

- [Pre-Commit Hook](https://github.com/EQuimper/nodejs-api-boilerplate#pre-commit-hook)

- [Scripts](https://github.com/EQuimper/nodejs-api-boilerplate#scripts)

- [Dev-Debug](https://github.com/EQuimper/nodejs-api-boilerplate#dev-debug)

- [Why toJSON() on methods model](https://github.com/EQuimper/nodejs-api-boilerplate#why-tojson-on-methods-model-)

- [For validation on request](https://github.com/EQuimper/nodejs-api-boilerplate#for-validation-on-request)

- [Seeds](https://github.com/EQuimper/nodejs-api-boilerplate#seeds)

- [Docker](https://github.com/EQuimper/nodejs-api-boilerplate#docker)

- [Techs](https://github.com/EQuimper/nodejs-api-boilerplate#techs)

- [Todo](https://github.com/EQuimper/nodejs-api-boilerplate#todo)

## Build

This Boilerplate use webpack 3 to compile code.

## Installation

1. Clone the project `git clone https://github.com/EQuimper/nodejs-api-boilerplate.git`.

2. Install dependencies `yarn install` or `npm i`

3. Create a `.env` file in the root like the `.env.example` file.

4. For dev you need to have mongodb db locally. [How to?](https://github.com/EQuimper/nodejs-api-boilerplate#install-mongodb)

---

## Install Mongodb

With Homebrew you can just run `brew install mongodb` and after `brew services start mongodb`.

---

## Raven Log

For get raven log create account here: [Sentry](https://sentry.io/)

---

## Body Whitelist

For security have add a whitelist function for your `req.body` coming from the front end. You can take a look of it in the `contants.js` file.

```js

const WHITELIST = {

  posts: {

    create: ['title', 'text'],

    update: ['title', 'text'],

  },

  users: {

    create: ['email', 'username', 'password'],

  },

};

```

---

## Api Doc

Api doc his hosted on surge. [Link](http://equimper-nodejs-api-boilerplate.surge.sh/). For change the url and have your own docs just add you link in the `.env` file.

---

## Pre-Commit Hook

I've add `pre-commit` and `lint-staged` for lint your code before commit. That can maybe take time :bowtie:

---

## Scripts

### DEV

```

yarn dev

```

or

```

npm run dev

```

**PS** That can crash if this is the first time but don't worry give it 2 sec the scripts gonna work. He just need to created a dist folder :) This way you have only one command to run.

### DEV-DEBUG

```

yarn dev:debug

```

or

```

npm run dev:debug

```

---

## Why toJSON on methods model ?

`toJSON()` help us to get only the data we want when we push the info to the client. So now we just need to put the user object in the `res.json(user)` and we received only what we want. Why `toAuthJSON()` ? Cause if we populated the post we get the `toJSON()` so the `toAuthJSON()` is the on to call on signup and login for get the token and _id.

```js

toAuthJSON() {

  return {

    _id: this._id,

    token: `JWT ${this.createToken()}`,

  };

},

toJSON() {

  return {

    _id: this._id,

    username: this.username,

  };

},

```

---

## For Validation on Request

I'm using Joi in this boilerplate, that make the validation really easy.

```js

export const validation = {

  create: {

    body: {

      email: Joi.string().email().required(),

      password: Joi.string().regex(/^[a-zA-Z0-9]{3,30}$/).required(),

      username: Joi.string().min(3).max(20).required(),

    },

  },

};

routes.post(

  '/signup',

  validate(UserController.validation.create),

  UserController.create,

);

```

## Seeds

For seed just run one of this following comand. This is helpful in dev for making fake user.

**This is only available in dev environment**

*You can change the number of seed by changing the number in each script inside `/scripts/seeds`*

- Seeds 10 user `yarn db:seeds-user`

- Clear user collection `yarn db:seeds-clear-user`

- Clear all collection `yarn db:seeds-clear`

---

Monitoring Server on `http://localhost:3000/status`

---

## Docker

```

bash scripts/development.sh

```

---

## Techs

- [Helmet](https://github.com/helmetjs/helmet)

- [Cors](https://github.com/expressjs/cors)

- [Body-Parser](https://github.com/expressjs/body-parser)

- [Morgan](https://github.com/expressjs/morgan)

- [PassportJS](https://github.com/jaredhanson/passport)

- [Passport-Local](https://github.com/jaredhanson/passport-local)

- [Passport-JWT](https://github.com/themikenicholson/passport-jwt)

- [Raven](https://github.com/getsentry/raven-node)

- [Joi](https://github.com/hapijs/joi)

- [Http-Status](https://github.com/adaltas/node-http-status)

- [Lint-Staged](https://github.com/okonet/lint-staged)

- [Husky](https://github.com/typicode/husky)

- [Prettier](https://github.com/prettier/prettier)

- [Eslint Config EQuimper](https://github.com/EQuimper/eslint-config-equimper)

- [Eslint Config Prettier](https://github.com/prettier/eslint-config-prettier)

- [CodeClimate](https://codeclimate.com/)

- [Coveralls](https://github.com/integrations/coveralls)

- [Travis Ci](https://travis-ci.org/)

- [Circle Ci](https://circleci.com/)

- [Greenkeeper](https://greenkeeper.io/)

- [Istanbul](https://github.com/gotwarlost/istanbul)

- [Mocha](https://github.com/mochajs/mocha)

- [Chai](https://github.com/chaijs/chai)

- [Supertest](https://github.com/visionmedia/supertest)

- [NPS](https://github.com/kentcdodds/nps)

- [MongoDB](https://www.mongodb.com/)

- [Mongoose](http://mongoosejs.com/)

- [Webpack3](https://webpack.js.org/)

---

## Todo

- [x] Test seeds controller - Done by [cpenarrieta](https://github.com/cpenarrieta)

- [ ] Sendgrid or Other Mail supply

- [ ] Add S3 for user image

- [ ] Change Mocha for Jest

# PR are welcome!!! 😃

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [
_{Emanuel Quimper}](https://equimper.me/)
[💬](#question-EQuimper "Answering Questions") [📝](#blog-EQuimper "Blogposts") [🐛](https://github.com/EQuimper/nodejs-api-boilerplate/issues?q=author%3AEQuimper "Bug reports") [💻](https://github.com/EQuimper/nodejs-api-boilerplate/commits?author=EQuimper "Code") [📖](https://github.com/EQuimper/nodejs-api-boilerplate/commits?author=EQuimper "Documentation") [💡](#example-EQuimper "Examples") [🚇](#infra-EQuimper "Infrastructure (Hosting, Build-Tools, etc)") [🔌](#plugin-EQuimper "Plugin/utility libraries") [👀](#review-EQuimper "Reviewed Pull Requests") [⚠️](https://github.com/EQuimper/nodejs-api-boilerplate/commits?author=EQuimper "Tests") [🔧](#tool-EQuimper "Tools") [✅](#tutorial-EQuimper "Tutorials") | [
_{Cristian Penarrieta}](https://medium.com/@cpenarrieta)
[⚠️](https://github.com/EQuimper/nodejs-api-boilerplate/commits?author=cpenarrieta "Tests") |

| :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!