Express Starter

🚚 A boilerplate for Node.js, Express, Mongoose, Heroku, Atlas, Nodemon, PM2, and Babel.

//

🌈 Live Demo

This seed repository provides the following features:

• ---------- Essentials ----------
• [x] Web application framework with Express.
• [x] Object-document mapping with Mongoose.
• [x] Make authenticated requests with Passport.
• [x] File upload with Multer.
• [x] Real-time communication with WS.
• ---------- Tools ----------
• [x] Next generation JavaScript with Babel.
• [x] JavaScript static code analyzer with ESLint.
• [x] Code formatter with Prettier.
• [x] Unit testing with Jest.
• [x] End-to-End testing with Supertest.
• [x] Mocking external requests with Nock.
• [x] Automatically restart application with Nodemon.
• [x] Keeping application alive with PM2.
• [x] Reverse proxy with Caddy.
• ---------- Environments ----------
• [x] Cloud application hosting with Heroku.
• [x] Cloud NoSQL database hosting with Atlas.
• [x] Cloud storage‎ hosting with Cloudinary.
• [x] Error tracking service with Sentry.
• [x] Software container with Docker.
• [x] Continuous integration with CircleCI.
• [x] Fix and prevent known vulnerabilities with Snyk.
• [x] Test coverage integration with Codecov.

Table of Contents

• Getting Started
• Dockerization
• Configuration
• Examples
• Directory Structure
• Microservices

Getting Started

Follow steps to execute this boilerplate.

1. Clone this boilerplate

$ git clone --depth 1 https://github.com/Shyam-Chen/Express-Starter.git <PROJECT_NAME>
$ cd <PROJECT_NAME>

2. Install dependencies

$ npm install

3. Start a development server

$ yarn serve

4. Produce a production-ready bundle

$ yarn build

5. Lint and fix files

$ yarn lint

6. Run unit tests

$ yarn unit

7. Run end-to-end tests

$ yarn e2e

• MongoDB

$ brew tap mongodb/brew
$ brew install mongodb-community
$ mongo --version
# MongoDB shell version v4.4.1
# Build Info: {
#     "version": "4.4.1",
#     "gitVersion": "ad91a93a5a31e175f5cbf8c69561e788bbc55ce1",
#     "modules": [],
#     "allocator": "system",
#     "environment": {
#         "distarch": "x86_64",
#         "target_arch": "x86_64"
#     }
# }

# Starting MongoDB
$ brew services run mongodb-community
$ brew services list

# Stopping MongoDB
$ brew services stop mongodb-community

Dockerization

Dockerize an application.

1. Build and run the container in the background

$ docker-compose up -d app

2. Run a command in a running container

$ docker-compose exec app <COMMAND>

3. Remove the old container before creating the new one

$ docker-compose rm -fs

4. Restart up the container in the background

$ docker-compose up -d --build app

Local Databases

$ docker-compose up -d mongodb

Configuration

Control the environment.

Default environments

Set your local environment variables.

// src/env.js

export const NODE_ENV = process.env.NODE_ENV || 'development';
export const INDEX_NAME = process.env.INDEX_NAME || 'local';

export const HOST = process.env.HOST || '0.0.0.0';
export const PORT = process.env.PORT || 3000;

export const SECRET_KEY = process.env.SECRET_KEY || 'jbmpHPLoaV8N0nEpuLxlpT95FYakMPiu';

export const MONGODB_URI = process.env.MONGODB_URI || 'mongodb://127.0.0.1:27017/test';
export const REDIS_URL = process.env.REDIS_URL || 'redis://127.0.0.1:6379/4';

// ---

export const CLOUDINARY_URL = process.env.CLOUDINARY_URL || 'cloudinary://key:[email protected]_name';

export const RATE_LIMIT = process.env.RATE_LIMIT || 0;

export const SENTRY_DSN = process.env.SENTRY_DSN || null;

Continuous integration environments

Add environment variables to the CircleCI build.

# Project Settings > Environment Variables > Add Environment Variable

SECRET_KEY
MONGODB_URI
SENTRY_DSN

Examples

• Hello World
• CRUD Operations
• Authentication
• File Uploads
• Realtime Data

Directory Structure

The structure follows the LIFT Guidelines.

.
├── src
│   ├── core
│   │   └── ...
│   ├── <FEATURE> -> feature modules
│   │   ├── __tests__
│   │   │   ├── controller.spec.js
│   │   │   ├── service.spec.js
│   │   │   ├── model.spec.js
│   │   │   └── rest|<FLOW>.e2e-spec.js
│   │   ├── controller.js
│   │   ├── service.js
│   │   ├── model.js
│   │   └── index.js
│   ├── <GROUP> -> module group
│   │   └── <FEATURE> -> feature modules
│   │       ├── __tests__
│   │       │   ├── controller.spec.js
│   │       │   ├── service.spec.js
│   │       │   ├── model.spec.js
│   │       │   └── rest|<FLOW>.e2e-spec.js
│   │       ├── controller.js
│   │       ├── service.js
│   │       ├── model.js
│   │       └── index.js
│   ├── app.js
│   ├── env.js
│   └── server.js
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .prettierrc
├── babel.config
├── Caddyfile
├── circle.yml
├── docker-compose.yml
├── Dockerfile
├── jest.config.js
├── LICENSE
├── package-lock.json
├── package.json
├── processes.js
└── README.md

Microservices

Microservice architecture – a variant of the service-oriented architecture structural style – arranges an application as a collection of loosely coupled services. In a microservices architecture, services are fine-grained and the protocols are lightweight.

See Server-side Micro-Fullstack for instructions on how to create microservices from source code.