NodeJS Express Boilerplate

NodeJS Express Rest API Boilerplate / Ready To Use.

Tech Stack :

• Postgresql
• Sequelize
• JWT Authentication
• API Documentation (Swagger)
• Cloudinary Storage
• Redis
• Bull

Feature

• Login with JWT Authentication
• Signup with email notification
• Guard API with JWT Auth Guard
• Upload Image / File to Cloudinary
• Use Redis Bull for Queue Job
• Sequelize Migration
• Use Pino for Logging

How To Install

1. Clone This Repo

git clone https://github.com/danudenny/nodejs-boilerplate

2. Install Package

# NPM
npm install

# Yarn
yarn install

3. Copy .env.example to .env
4. Populate .env

• App dan Database

PORT = 3000
DEV_DATABASE_URL = postgres://<db_user>:<db_password>@127.0.0.`:5432/<db_name>
DATABASE_URL = postgres://<db_user>:<db_password>@127.0.0.1:5432/<db_name>
NODE_ENV = development

• Mail

ADMIN_EMAIL = email@email.com
MAIL_USERNAME = username
MAIL_PASSWORD = password
MAIL_HOST = smtp.mailtrap.io
MAIL_PORT = 2525

• JWT

JWT_SECRET = <jsonwebtokensecret>

• Cloudinary

CLOUD_NAME= <cloudynaryname>
API_KEY= <cloudynaryAPIKey>
API_SECRET= <cloudynaryAPISecret>

5. Set Environment Development database/config/config.js
6. Start The API yarn start or yarn start:dev

Postman Documentation

Link Postman Documentation