crgavrila/node-express-boilerplate-app

Node, Express, mongoose, mongodb, typescript

NodeJS Server Boilerplate

by Joao Paulo Furtado

Table of Contents

• Installation
• Usage

Installation

First you should configure your serverConfig.ts file inside src/constants folder. It should follow the following format:

const appName = 'App Boilerplate';
const supportEmail = '[email protected]';

export const serverConfig = {
  app: {
    name: appName,
    devUrl: 'http://localhost:3000/',
    productionUrl: 'https://appboilerplate.io'
  },
  email: {
    supportEmail,
    sendGridAPIKey:
      'API_KEY',
    templatesFolder: './src/emails/templates',
    globalTemplateVars: {
      'Product Name': appName,
      'Sender Name': 'Joao',
      'Company Name, LLC': 'App Boilerplate Inc',
      'Company Address': '1234, Street Rd. Suite 1234'
    }
  },
  env: 'dev',
  maintenanceMode: false,
  language: 'eng',
  jwtSecret: 'yourJWTTOKEN'
};

Usage

Run:

docker-compose up

Useful commands

• SSH into running container:

1. Check the running docker containers:

docker ps

then select one (name). For example: docker-node-mongo. Then run:

docker exec -it docker-node-mongo /bin/bash

Mongo Admin

• Access http://localhost:1234 to manage your mongodb database