π A boilerplate for Node.js, Express, Mongoose, Heroku, Atlas, Nodemon, PM2, and Babel.
π Live Demo
πͺ This seed repository provides the following features:
- ---------- Essentials ----------
- Web application framework with Express.
- Object-document mapping with Mongoose.
- Make authenticated requests with Passport.
- File upload with Multer.
- Real-time communication with WS.
- ---------- Tools ----------
- Next generation JavaScript with Babel.
- JavaScript static code analyzer with ESLint.
- Code formatter with Prettier.
- Unit testing with Jest.
- End-to-End testing with Supertest.
- Mocking external requests with Nock.
- Automatically restart application with Nodemon.
- Keeping application alive with PM2.
- Reverse proxy with Caddy.
- ---------- Environments ----------
- Cloud application hosting with Heroku.
- Cloud NoSQL database hosting with Atlas.
- Cloud storage hosting with Cloudinary.
- Error tracking service with Sentry.
- Software container with Docker.
- Continuous integration with CircleCI.
- Fix and prevent known vulnerabilities with Snyk.
- Test coverage integration with Codecov.
Note
π€ Think about next-generation application development:
- Fastify is one of the fastest Node.js web frameworks.
- Nest uses a modular architecture and allows the choice of either Express or Fastify as the server framework.
If you're interested in Fastify, you can refer to my Fastify Starter.
Follow steps to execute this boilerplate.
$ npm install$ brew services start mongodb-community
$ yarn serve$ yarn build$ yarn lintFiles: src/**/*.spec.js
$ yarn unitFiles: e2e/**/*.spec.js
# Before running the `meas` command, make sure to run the following commands.
$ yarn build
$ yarn preview
# If it's not setup, run it.
$ yarn setup
$ yarn e2eFiles: e2e/**/*.meas.js
# Before running the `meas` command, make sure to run the following commands.
$ yarn build
$ yarn preview
# If it's not setup, run it.
$ yarn setup
$ yarn meas# If it's not active, run it.
$ yarn active
$ yarn mockDockerize an application.
- Build and run the container in the background
$ docker-compose up -d mongodb app- Run a command in a running container
$ docker-compose exec app <COMMAND>- Remove the old container before creating the new one
$ docker-compose rm -fs- Restart up the container in the background
$ docker-compose up -d --build appControl the environment.
Set your local environment variables. (use export const <ENV_NAME> = process.env.<ENV_NAME> || <LOCAL_ENV>;)
// 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 FACEBOOK_APP_ID = process.env.FACEBOOK_APP_ID || 'XXX';
export const FACEBOOK_APP_SECRET = process.env.FACEBOOK_APP_SECRET || 'XXX';
export const GOOGLE_CLIENT_ID = process.env.GOOGLE_CLIENT_ID || 'XXX';
export const GOOGLE_CLIENT_SECRET = process.env.GOOGLE_CLIENT_SECRET || 'XXX';
export const APPLE_SERVICES_ID = process.env.APPLE_SERVICES_ID || 'XXX';
export const APPLE_TEAM_ID = process.env.APPLE_TEAM_ID || 'XXX';
export const APPLE_KEY_ID = process.env.APPLE_KEY_ID || 'XXX';
export const APPLE_PRIVATE_KEY = process.env.APPLE_PRIVATE_KEY || 'XXX';
export const CLOUDINARY_URL = process.env.CLOUDINARY_URL || 'cloudinary://key:secret@domain_name';
export const RATE_LIMIT = process.env.RATE_LIMIT || 0;
export const SENTRY_DSN = process.env.SENTRY_DSN || null;Add environment variables to the CircleCI build.
# Project Settings > Environment Variables > Add Environment Variable
SECRET_KEY
MONGODB_URI
CLOUDINARY_URL
SENTRY_DSNIf you want to set environment variables from a file.
.
βββ e2e
βββ envs
β βββ dev.js
β βββ stage.js
β βββ prod.js
βββ mock
βββ src// envs/<ENV_NAME>.js
function Environment() {
this.NODE_ENV = 'production';
// more...
}
module.exports = new Environment();$ npm install babel-plugin-transform-inline-environment-variables env-cmd -D// babel.config.js
plugins: [
// ...
'transform-inline-environment-variables',
],// package.json
"scripts": {
// "env-cmd -f ./envs/<ENV_NAME>.js" + "yarn build"
"build:dev": "env-cmd -f ./envs/dev.js yarn build",
"build:stage": "env-cmd -f ./envs/stage.js yarn build",
"build:prod": "env-cmd -f ./envs/prod.js yarn build",
},The structure follows the LIFT Guidelines.
.
βββ e2e
βββ mock
β βββ requests
β βββ responses
βββ src
β βββ core
β β βββ ...
β βββ <FEATURE> -> feature modules
β β βββ __tests__
β β β βββ controller.spec.js
β β β βββ service.spec.js
β β β βββ model.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
β β βββ controller.js
β β βββ service.js
β β βββ model.js
β β βββ index.js
β βββ app.js
β βββ env.js
β βββ server.js
βββ .editorconfig
βββ .eslintrc
βββ .gitignore
βββ .prettierrc
βββ babel.config
βββ Caddyfile
βββ circle.yml
βββ develop.Dockerfile
βββ docker-compose.yml
βββ Dockerfile
βββ jest.config.js
βββ LICENSE
βββ package-lock.json
βββ package.json
βββ processes.js
βββ produce.Dockerfile
βββ README.mdMicroservice 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.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent