Sentnel node js repository

Get Started

• Installation
• Install Mongodb
• Raven Log
• Body Whitelist
• Api Doc
• Pre-Commit Hook
• Scripts
• Dev-Debug
• Why toJSON() on methods model
• For validation on request
• Seeds
• Docker
• Techs
• 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?

---

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

---

---

Api Doc

Api doc his hosted on surge. Link. For change the url and have your own docs just add you link in the .env file.

---

---

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 ?

---

For Validation on Request

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

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(),
    },
  },
};

---

Monitoring Server on http://localhost:3000

---

---

Techs

• Cors
• Body-Parser
• Raven
• Joi
• Husky
• Prettier
• Mocha
• Chai
• NPS
• MongoDB
• Mongoose
• Webpack3

---