Merge pull request #3 from mugarate12/feature/add_nginx_and_pm2

Feature/add nginx and pm2

Author: mugarate12

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.5] - 2022-10-25
+### Added
+- Add Nginx and PM2 to production build of docker
+
 ## [1.1.5] - 2022-10-18
 ### Added
 - Create Docker files to development, test and production builds

README.md

@@ -48,6 +48,10 @@ project
 │   package.json
 │   tsconfig.json
 │   tsconfig.spec.json
+│   pm2.json
+│   nginx
+|   │   default.conf
+|   │   Dockerfile
 │   __tests__
 │   └───unit
 |   │   |  example.test.ts
@@ -89,6 +93,11 @@ build your project and immediately run your app builded:
 npm start
 ```
 
+run project in production mode with pm2:
+```shell
+npm run start:pm2
+```
+
 run project in development build:
 ```shell
 npm run dev

package.json

@@ -1,6 +1,6 @@
 {
   "name": "basic-node-ts-config",
-  "version": "1.1.5",
+  "version": "1.2.5",
   "description": "Configuração básica para um ambiente de desenvolvimento com NodeJs + TypeScript",
   "main": "./lib/copyFile.js",
   "preferGlobal": true,

project/Dockerfile

@@ -9,6 +9,7 @@ COPY package*.json ./
 
 # Install app dependencies
 RUN npm i 
+RUN npm install pm2 -g
 
 # Copy all files from current directory to app directory
 COPY . .
@@ -17,4 +18,4 @@ COPY . .
 EXPOSE 8000
 
 # Run the app
-CMD [ "npm", "start" ]
+CMD [ "npm", "run", "start:pm2-runtime" ]

project/README.md

@@ -44,6 +44,11 @@ build your project and immediately run your app builded:
 npm start
 ```
 
+run project in production mode with pm2:
+```shell
+npm run start:pm2
+```
+
 run project in development build:
 ```shell
 npm run dev
@@ -108,12 +113,16 @@ project
 │   package.json
 │   tsconfig.json
 │   tsconfig.spec.json
+│   pm2.json
 │   __tests__
 │   └───unit
 |   │   |  example.test.ts
 |   │   |  redis.test.ts
 │   └───integration
 |   │   |  example.test.ts
+│   nginx
+|   │   default.conf
+|   │   Dockerfile
 └───src
 |   |   app.ts
 |   |   server.ts

project/docker-compose.yml

@@ -1,18 +1,26 @@
 version: "3.9" 
-restart: always
 
 services:
+  nginx:
+    restart: always
+    build: ./nginx
+    ports:
+      - "80:80"
+
   redis:
+    restart: always
     image: redis
     container_name: cache
     expose:
       - 6379
 
   app:
+    restart: always
     build: ./
     volumes:
       - ./:/var/www/app
     depends_on:
+      - nginx
       - redis
     ports:
       - "8000:8000"
@@ -21,5 +29,5 @@ services:
       - NODE_ENV=production
       - PORT=8000
     command: 
-      sh -c 'npm start'
+      sh -c 'npm run start:pm2-runtime'
 

project/nginx/Dockerfile

@@ -0,0 +1,4 @@
+FROM nginx
+
+# Copy the nginx configuration file
+COPY default.conf /etc/nginx/conf.d/default.conf

project/nginx/default.conf

@@ -0,0 +1,16 @@
+server {
+    server_name _;
+    
+    # access_log /var/log/nginx/nodeapp.log;
+    # error_log  /var/log/nginx/nodeapp-error.log error;
+
+    location / {
+      proxy_read_timeout 3600;
+      proxy_set_header HOST $host;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $scheme;
+
+      proxy_pass http://app:8000; # change the port according to your nodejs port
+    }
+}

project/package.json

@@ -7,6 +7,8 @@
     "build": "tsc",
     "dev": "ts-node-dev --poll --respawn --transpile-only --ignore-watch node_modules src/server.ts",
     "start": "npm run build&&node build/src/server.js",
+    "start:pm2": "npm run build&&pm2 start pm2.json",
+    "start:pm2-runtime": "npm run build&&pm2-runtime start pm2.json",
     "test": "SET NODE_ENV=test&&jest",
     "test:docker": "jest",
     "docker:test": "docker-compose -f ./docker-compose.test.yml up",
@@ -16,7 +18,7 @@
     "docker:prod": "docker-compose -f ./docker-compose.yml up",
     "docker:prod:build": "docker-compose -f ./docker-compose.yml up --build"
   },
-  "keywords": [],
+  "keywords": ["node", "typescript", "express", "jest", "docker"],
   "author": "",
   "license": "ISC",
   "dependencies": {

project/pm2.json

@@ -0,0 +1,18 @@
+{
+  "apps": [
+    {
+      "name": "primary",
+      "instances": 1,
+      "exec_mode": "cluster",
+      "script": "./build/src/server.js",
+      "instance_var": "INSTANCE_ID"
+    },
+    {
+      "name": "replica",
+      "instances": -1,
+      "exec_mode": "cluster",
+      "script": "./build/src/server.js",
+      "instance_var": "INSTANCE_ID"
+    }
+  ]
+}