Code clean up. (#9)

* Code clean up.

* Fix CI Workflow.

* Update Readme.

Author: jonepl

.github/workflows/ci.yml

@@ -47,10 +47,10 @@ jobs:
         run: docker-compose -f docker-compose.yml config
 
       - name: Validate Mock Server Docker Compose file
-        run: docker-compose -f docker-compose.server.yml config
+        run: docker-compose -f local-server/docker-compose.server.yml config
 
       - name: Validate Mock Server Application Docker Compose file
-        run: docker-compose -f docker-compose.server.yml config
+        run: docker-compose -f local-server/docker-compose.server.yml config
 
   tests:
     name: Test Mail Server

Dockerfile.local

@@ -5,10 +5,10 @@ start-portfolio-dev:
 	npm --prefix portfolio/ run dev
 
 build-mock-server:
-	docker build -f Dockerfile.local -t mock-server:latest .
+	docker build -f local-server/Dockerfile.local -t mock-server:latest .
 
 start-mock-server:
-	docker-compose -f docker-compose.server.yml up -d
+	docker-compose -f local-server/docker-compose.server.yml up -d
 	# Wait for dockerd to be ready
 	until docker exec mock-server docker info > /dev/null 2>&1; do \
 		echo "Waiting for Docker daemon in mock-server to be ready..."; \
@@ -18,4 +18,4 @@ start-mock-server:
 	docker exec mock-server /srv/app/entrypoint.sh
 
 stop-mock-server:
-	docker-compose -f docker-compose.server.yml down
+	docker-compose -f local-server/docker-compose.server.yml down

Makefile

@@ -9,12 +9,12 @@ This repository contains the Web Portfolio for the hosted applications. The Web
 
 ## Design
 <p align="center">
- <img src="./docs/Web-Portfolio.jpg" style="display: block; margin: 0 auto">
+ <img src="./docs/Web-Portfolio-V2.jpg" style="display: block; margin: 0 auto">
 </p>
 
 <br/>
 
-This web portfolio runs an Nginx web server to host the static files within a docker container. The docker-compose file is meant to be used within a docker-swarm instance.
+This web portfolio application runs an Nginx web server to host the static files and a Nodejs to handle SMTP messages within a Docker Swarm service.
 
 ## Prerequisites
 * NodeJS
@@ -24,35 +24,47 @@ This web portfolio runs an Nginx web server to host the static files within a do
 
 This web portfolio uses a NodeJS mail server which you must configured to send emails. 
 
-* Read name `.env.config.example` to `.env.config` and update PORT value if needed
-* Read name  `.env.secret.example` to `.env.secret` and provide the
+* Rename `.env.config.example` to `.env.config` and update APP_PORT, SMTP_HOST values as needed
 
-  ```
-  # Email server
-  SERVICE="yahoo"
-  
+```conf
+# Node applicaiton port
+APP_PORT=3000
+
+# Mail server host
+SMTP_HOST=smtp.mail.yahoo.com
+
+# Mail server port
+SMTP_PORT=587
+```
+
+* Rename `.env.secret.example` to `.env.secret` and update EMAIL, EMAIL_PASS, FORWARDING_EMAIL values as needed
+
+  ```  conf
   # Sender's email address
-  EMAIL_USER="example@yahoo.com"
+  EMAIL="example@yahoo.com"
 
-  # Email Application Password
+  # Sender's Application Email Password
   EMAIL_PASS="mypassword"
 
   # Recipient's email address
-  FORWARD_EMAIL_USER="myemail@yahoo.com"
+  FORWARDING_EMAIL="myemail@yahoo.com"
   ```
 
 ### Running Dev Locally
 1. Open a terminal shell and run `make start-server-dev`
 2. Open a second terminal and run  `start-portfolio-dev`
 3. Access web portfolio via `http://localhost:4000`
+4. Stop locally started app by press Ctrl + C within both terminals
 
 ### Running Docker Swarm Locally
 1. Build the mock server with `make build-mock-server`
 2. Start mock server with `make start-mock-server`
 3. Access web portfolio via `http://localhost`
+4. Stop the mock server with `make stop-mock-server`
 
 NOTE: The above steps will simulate a remote server. An entrypoint.sh script will initialize Docker Swarm, create networks, secrets, configs, build images and start the web portfolio services. The application should be accessible via port 80.
 
 ## Pre-Merge Checklist
 * Update [Portfolio VERSION](./portfolio/VERSION) or [Mail Server VERSION](./mail-server/VERSION)
+* Update [Portfolio package.json](./portfolio/package.json) or [Mail Server package.json](./mail-server/package.json)
 * Update [Porfolio CHANGELOG.md](./portfolio/CHANGELOG.md) or [Mail Server CHANGELOG.md](./mail-server/CHANGELOG.md)

README.md

@@ -1,11 +1,24 @@
 version: '3.8'
 
 services:
+  api-gateway:
+    image: nginx:latest
+    container_name: api-gateway
+    ports:
+      - "80:80"
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    networks:
+      - portfolio-network
+    depends_on:
+      - portfolio
+      - mail-server
+
   web-portfolio:
     container_name: web-portfolio
     image: web-portfolio:latest
-    ports:
-      - "80:80"
+    expose:
+      - "3000"
     depends_on:
       - mail-server
     networks:
@@ -24,10 +37,13 @@ services:
 
   mail-server:
     image: mail-server:latest
+    expose:
+      - "3000"
     secrets:
       - mail_server_secret
     configs:
-      - mail_server_config
+      - source: mail_server_config
+        target: /run/config/mail_server_config
     networks:
       - portfolio-network
     deploy:

docs/Web-Portfolio-V2.jpg

@@ -0,0 +1,28 @@
+events {
+  worker_connections 1024;
+}
+
+http {
+  server {
+    listen 80;
+    server_name localhost;
+
+    # Web Portfoli Routing
+    location / {
+      proxy_pass http://web-portfolio:80;
+      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;
+    }
+
+    # Mail Server Routing
+    location /send-email {
+      proxy_pass http://mail-server:3000;
+      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;
+    }
+  }
+}

docker-compose.local.yml local-server/docker-compose.local.ymldocker-compose.local.yml renamed to local-server/docker-compose.local.yml

@@ -1,2 +1,3 @@
-EMAIL_PORT=3000
-EMAIL_HOST=localhost
+APP_PORT=3000
+SMTP_HOST=smtp.mail.yahoo.com
+SMTP_PORT=587