add docker file

Author: janishar

.dockerignore

@@ -0,0 +1,25 @@
+# Add any directories, files, or patterns you don't want to be tracked by version control
+.idea
+
+# ignore vs code project config files
+.vscode
+.vs
+
+# ignore logs
+/logs
+*.log
+
+# ignore 3rd party lib
+/node_modules
+
+# Ignore built files
+build/**/*
+
+# ignore test converage
+/coverage
+
+# git
+.gitignore
+.git
+
+.DS_Store 

.env.example

@@ -12,15 +12,20 @@ CORS_URL=*
 # Databse 
 DB_NAME=YOUR_MONGO_DB_NAME
 #localhost or IP of the server
-DB_HOST=YOUR_MONGO_DB_HOST_NAME
+# If using the docker installation then use 'mongo' for host name else localhost or ip or db server
+DB_HOST=YOUR_MONGO_DB_HOST_NAME 
 DB_PORT=27017
 DB_USER=YOUR_MONGO_DB_USER_NAME
-DB_PWD=YOUR_MONGO_DB_USER_PWD
+DB_USER_PWD=YOUR_MONGO_DB_USER_PWD
 
-#Log
-#Example '/Users/janisharali/logs'
-#DEFAUlT is this project's directory
-LOG_DIR=YOUR_DIRECTORY_PATH_FOR_LOG_FILES 
+# Admin when using Docker
+DB_ADMIN=admin
+DB_ADMIN_PWD=changeit
+
+# Log
+# Example '/home/node/logs'
+# DEFAUlT is this project's directory
+# LOG_DIR=YOUR_DIRECTORY_PATH_FOR_LOG_FILES 
 
 # Token Info
 ACCESS_TOKEN_VALIDITY_DAYS=30

.gitignore

@@ -12,10 +12,6 @@
 # ignore 3rd party lib
 /node_modules
 
-# ignore vs code project config files
-/config.js
-/config.json
-
 # ignore key
 *.pem
 

Dockerfile

@@ -0,0 +1,23 @@
+# Here we are getting our node as Base image
+FROM node:latest
+
+# create user in the docker image
+USER node
+
+# Creating a new directory for app files and setting path in the container
+RUN mkdir -p /home/node/app && chown -R node:node /home/node/app
+
+# setting working directory in the container
+WORKDIR /home/node/app
+
+# grant permission of node project directory to node user
+COPY --chown=node:node . .
+
+# installing the dependencies into the container
+RUN npm install
+
+# container exposed network port number
+EXPOSE 3000
+
+# command to run within the container
+CMD [ "npm", "start" ]

docker-compose.yml

@@ -0,0 +1,56 @@
+version: '3'
+
+services:
+  app:
+    # This defines the configuration options, including the context and dockerfile, 
+    # that will be applied when Compose builds the application image.
+    build:
+      # This defines the build context for the image build — in this case, the current project directory.
+      context: .
+      # This specifies the Dockerfile in your current project directory as the file
+      dockerfile: Dockerfile
+    image: app
+    container_name: app
+    # This defines the restart policy. The default is no, 
+    # but we have set the container to restart unless it is stopped.
+    restart: unless-stopped
+    env_file: .env
+    ports:
+      # This maps port from .env on the host to same port number on the container.
+      - "3000:$PORT"
+    links:
+      - mongo
+    volumes:
+      # This is a bind mount that mounts our application code on the host to the /home/node/app directory on the container.
+      # Any changes you make to your host code will be populated immediately in the container.
+    - ./:/home/node/app
+    
+
+  mongo:
+    # To create this service, Compose will pull the mongo
+    image: mongo:latest
+    container_name: mongo
+    restart: unless-stopped
+    # This tells Compose that we would like to add environment variables 
+    # from a file called .env, located in our build context.
+    env_file: .env
+    environment:
+      # MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD together create
+      # a root user in the admin authentication database and ensure that authentication is enabled 
+      # when the container starts. We have set MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD 
+      # using the values from our .env file, which we pass to the db service using the env_file option.
+      - MONGO_INITDB_ROOT_USERNAME=$DB_ADMIN
+      - MONGO_INITDB_ROOT_PASSWORD=$DB_ADMIN_PWD
+    ports:
+      - "27017:27017"
+    volumes:     
+      # The named volume dbdata will persist the data stored in Mongo’s default data directory, /data/db. 
+      # This will ensure that you don’t lose data in cases where you stop or remove containers.
+    - dbdata:/data/db
+
+# Our top-level volumes key defines the volumes dbdata. 
+# When Docker creates volumes, the contents of the volume are stored in a part of the host filesystem, /var/lib/docker/volumes/, that’s managed by Docker. 
+# The contents of each volume are stored in a directory under /var/lib/docker/volumes/ and get mounted to any container that uses the volume. 
+# In this way, the data that our users will create will persist in the dbdata volume even if we remove and recreate the db container.
+volumes:
+  dbdata:

package-lock.json

@@ -9,10 +9,11 @@
     "build": "npm run build-ts",
     "watch": "concurrently -k -p \"[{name}]\" -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold,green.bold\" \"npm run watch-ts\" \"npm run watch-node\"",
     "watch-node": "nodemon -r dotenv/config build/server.js",
-    "build-ts": "tsc",
-    "watch-ts": "tsc -w",
+    "build-ts": "npm run tsc",
+    "watch-ts": "npm run tsc -w",
     "tslint": "tslint -c tslint.json -p tsconfig.json",
-    "test": "jest --forceExit --detectOpenHandles --coverage --verbose"
+    "test": "jest --forceExit --detectOpenHandles --coverage --verbose",
+    "tsc": "./node_modules/typescript/bin/tsc"
   },
   "repository": {
     "type": "git",
@@ -31,6 +32,7 @@
     "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.15",
     "mongoose": "^5.9.5",
+    "typescript": "^3.8.3",
     "winston": "^3.2.1",
     "winston-daily-rotate-file": "^4.4.2"
   },
@@ -56,7 +58,6 @@
     "supertest": "^4.0.2",
     "ts-jest": "^25.2.1",
     "ts-node": "^8.8.1",
-    "tslint": "^6.1.0",
-    "typescript": "^3.8.3"
+    "tslint": "^6.1.0"
   }
 }

package.json

@@ -7,7 +7,7 @@ export const db = {
 	host: process.env.DB_HOST,
 	port: process.env.DB_PORT,
 	user: process.env.DB_USER,
-	password: process.env.DB_PWD,
+	password: process.env.DB_USER_PWD,
 };
 
 export const corsUrl = process.env.CORS_URL;

src/config.ts

@@ -22,7 +22,10 @@ const options = {
 Logger.debug(dbURI);
 
 // Create the database connection
-mongoose.connect(dbURI, options);
+mongoose.connect(dbURI, options).catch(e => {
+	Logger.info('Mongoose connection error');
+	Logger.error(e);
+});
 
 // CONNECTION EVENTS
 // When successfully connected

src/database/index.ts

@@ -1,5 +1,5 @@
 import express from 'express';
-import KeystoreRepo from '../../../database/Repository/KeystoreRepo';
+import KeystoreRepo from '../../../database/repository/KeystoreRepo';
 import { ProtectedRequest } from 'app-request';
 import { SuccessMsgResponse } from '../../../core/ApiResponse';
 import asyncHandler from '../../../helpers/asyncHandler';