Merge pull request #143 from weaponsforge/feat/weaponsforge-142

feat: deploy development images to docker hub
weaponsforge · Oct 3, 2024 · 564871b · 564871b
2 parents 64d64e7 + 182b187
commit 564871b
Show file tree

Hide file tree

Showing 7 changed files with 161 additions and 11 deletions.
diff --git a/.github/workflows/pull-images.yml b/.github/workflows/pull-images.yml
@@ -0,0 +1,26 @@
+# Pull the Docker images from Docker Hub on schedule
+name: Pull Docker Images
+
+on:
+  schedule:
+    # Runs "At 00:00 on day-of-month 1 in every 2nd month."
+    - cron: '0 0 1 */2 *'
+
+jobs:
+  pull-images:
+    name: Pull Development Image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Fetch and check out latest tag
+        run: |
+          git fetch --tags
+          LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+          echo "Checking out latest tag: $LATEST_TAG"
+          git checkout $LATEST_TAG
+          echo "LATEST_TAG=$LATEST_TAG" >> $GITHUB_ENV
+
+      - name: Pull Development Image
+        run: docker compose -f docker-compose.dev.yml pull
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -9,6 +9,7 @@ on:
 jobs:
   lint-client:
     name: Lint and Export client
+    if: github.event.release.target_commitish == 'master'
     runs-on: ubuntu-latest
     env:
       NEXT_PUBLIC_BASE_PATH: ${{ secrets.NEXT_PUBLIC_BASE_PATH }}
@@ -60,6 +61,7 @@ jobs:
 
   lint-server:
     name: Lint Server
+    if: github.event.release.target_commitish == 'master'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository
@@ -76,6 +78,7 @@ jobs:
 
   deploy-client:
     name: Deploy client to Github Pages
+    if: github.event.release.target_commitish == 'master'
     needs: lint-client
     runs-on: ubuntu-latest
     steps:
@@ -96,6 +99,7 @@ jobs:
 
   deploy-server:
     name: Deploy Server to Vercel
+    if: github.event.release.target_commitish == 'master'
     needs: lint-server
     runs-on: ubuntu-latest
     env:
@@ -129,3 +133,33 @@ jobs:
         run: |
           cd server
           rm -r -f .vercel
+
+  docker-build-push:
+    name: Push Image to Docker Hub
+    if: github.event.release.target_commitish == 'master' && vars.DOCKERHUB_USERNAME != ''
+    needs:
+      - lint-client
+      - lint-server
+    runs-on: ubuntu-latest
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Create env variables
+        run: |
+          cp client/.env.example client/.env
+          cp server/.env.example server/.env
+
+      - name: Build Image
+        run: docker compose -f docker-compose.dev.yml build
+
+      - name: Push Image to Docker Hub
+        run: docker compose -f docker-compose.dev.yml push
diff --git a/README.md b/README.md
@@ -18,6 +18,19 @@ Server: https://myphonebook-app.vercel.app/
 Website: https://myphonebook-app-dev.web.app/<br>
 Server: https://myphonebook-app-dev.vercel.app/
 
+### Table of Contents
+
+- [Live Preview](#live-preview)
+- [Software Documentation](#software-documentation)
+- [Requirements](#requirements)
+- [Manual Installation](#manual-installation)
+- [Installation Using Docker](#installation-using-docker)
+- [Docker for Localhost Development](#docker-for-localhost-development)
+   - [Build Local Images](#build-local-images)
+   - [Use Pre-Built Development Images](#use-pre-built-development-images)
+   - [Docker for Production Deployment](#docker-for-production-deployment)
+- [Deployment with GitHub Actions](#deployment-with-gitHub-actions)
+
 ## Software Documentation
 
 - [project plan v1.0](/project-plan.pdf)
@@ -62,9 +75,11 @@ The following dependencies are used to build and run the image. Please feel feel
 2. Docker version 23.0.1, build a5eeb1
 3. Docker Compose v2.16.0
 
-### Docker for Localhost Development
+## Docker for Localhost Development
+
+### Build Local Images
 
-1. Set up the environment variables for the `/client` and `/server` directories like mentioned in the [Manual Installation](#manual-installation) section, step no. 2.
+1. Set up the environment variables (`.env` files) for the `/client` and `/server` directories like mentioned in the [Manual Installation](#manual-installation) section, step no. 2.
 2. Verify that ports 3000 and 3001 are free because the client and server containers will use these ports.
 3. Stop current-running my-phonebook containers, if any.
    ```
@@ -90,6 +105,26 @@ The following dependencies are used to build and run the image. Please feel feel
    docker compose -f docker-compose.dev.yml down
    ```
 
+### Use Pre-Built Development Images
+
+This project deploys the latest **client** and **server** development Docker images to Docker Hub on the creation of new Release/Tags. They are available at:
+
+https://hub.docker.com/r/weaponsforge/my-phonebook
+
+1. Pull the pre-built development Docker image using any of the two (2) options:
+   - Open a terminal and run:
+      ```
+      docker pull weaponsforge/my-phonebook:client
+      docker pull weaponsforge/my-phonebook:server
+      ```
+   - Navigate to the gsites-components root project directory, then run:<br>
+   `docker compose -f docker-compose.dev.yml pull`
+
+2. Set up the environment variables (`.env` files) for the `/client` and `/server` directories like mentioned in the [Manual Installation](#manual-installation) section, step no. 2.
+
+3. Run the development images.<br>
+`docker compose -f docker-compose.dev.yml up`
+
 ### Docker for Production Deployment
 
 The following docker-compose commands build a small client image targeted for creating optimized dockerized apps running on self-managed production servers. An Nginx service serves the frontend client on port 3000. Hot reload is NOT available when editing source codes from the `/client` and `/server` directories.
@@ -109,5 +144,60 @@ The following docker-compose commands build a small client image targeted for cr
    docker compose -f docker-compose.prod.yml down
    ```
 
+## Deployment with GitHub Actions
+
+This project deploys the **development** environment to:
+
+- Firebase Hosting (front end)
+- Vercel (backend server)
+
+This project deploys the **production** environment to:
+
+- GitHub Pages (front end)
+- Vercel (backend server)
+
+The following requirements are optional. They are only required if there is a need to deploy the web application for live demonstration purposes. Be sure to check-out and setup the _**required**_ client and server environment variables before proceeding.
+
+### Requirements
+
+1. GitHub Pages setup
+2. Vercel account (2x, for development and production)
+   - pre-configured with a [stand-alone Express server](https://vercel.com/guides/using-express-with-vercel) of the repository's **server** component
+3. Firebase projects (2x, for development and production) initialized with:
+   - Firestore database
+   - Firebase Hosting
+   - Firebase Storage
+4. Docker Hub account
+   - (Optional) required to push the development images to Docker Hub
+
+#### GitHub Secrets
+
+| GitHub Secrets | Description |
+| --- | --- |
+| NEXT_PUBLIC_BASE_PATH | Root directory path name that NextJS uses for assets, media and client-side routing for the app.<br><br>Set its value to blank `''` when working on development mode in localhost.<br><br>Set its value to the sub-directory name where the exported NextJS app is to be deployed, i.e. `/<YOUR_REPOSITORY_NAME>` when<br> deploying on a repository (sub-directory) of a root GitHub Pages site, i.e, on `https://<YOUR_GITHUB_USERNAME>.github.io/<YOUR_REPOSITORY_NAME>` |
+| NEXT_PUBLIC_BASE_API_URL_DEV,<br>NEXT_PUBLIC_BASE_API_URL_PROD | My Phonebook's Vercel development/production server base API url minus the forward slash. |
+| FIREBASE_WEB_API_KEY_DEV,<br>FIREBASE_WEB_API_KEY_PROD | Development/production Firebase web API key from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_AUTHDOMAIN_DEV,<br>FIREBASE_WEB_AUTHDOMAIN_PROD | Development/production Firebase web auth domain key from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_PROJECT_ID_DEV,<br>FIREBASE_WEB_PROJECT_ID_PROD | Development/production Firebase web project ID from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_STORAGE_BUCKET_DEV,<br>FIREBASE_WEB_STORAGE_BUCKET_PROD | Development/production Firebase web storage bucket key from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_MESSAGING_SENDER_ID_DEV,<br>FIREBASE_WEB_MESSAGING_SENDER_ID_PROD | Development/production Firebase web messaging sender ID from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_APP_ID_DEV,<br>FIREBASE_WEB_APP_ID_PROD | Development/production Firebase web web app key from the Firebase Project Settings configuration file. |
+| FIREBASE_WEB_MEASUREMENT_ID_DEV,<br>FIREBASE_WEB_MEASUREMENT_ID_PROD | Development/production Firebase web measurement ID from the Firebase Project Settings configuration file. |
+| NEXT_PUBLIC_MEDIA_BG1 | Firebase storage download URL of the hi-resolution asset file "loginBgResized.jpg" |
+| NEXT_PUBLIC_RANDOM_JOKE_API | Access URL to the JokeAPI, a REST API that serves uniformly and well formatted jokes. |
+| VERCEL_ORG_ID_DEV,<br>VERCEL_ORG_ID_PROD | Development/production Vercel app organization ID |
+| VERCEL_PROJECT_ID_DEV,<br>VERCEL_PROJECT_ID_PROD | Development/production Vercel app project ID |
+| VERCEL_TOKEN | Vercel account's deployment token. |
+| DOCKERHUB_USERNAME | (Optional) Docker Hub username. Required to enable pushing the development image to Docker Hub. |
+| DOCKERHUB_TOKEN | (Optional) Deploy token for the Docker Hub account. Required to enable pushing the development image to the Docker Hub. |
+
+#### GitHub Variables
+
+| GitHub Variable | Description |
+| --- | --- |
+| DOCKERHUB_USERNAME | (Optional) Docker Hub username. Required to enable pushing the development image to Docker Hub. |
+
 @weaponsforge<br>
-20220222
+20220222<br>
+20241004
+
diff --git a/client/README.md b/client/README.md
@@ -44,7 +44,7 @@ The following dependecies are used for this project. Feel free to experiment usi
    | Variable Name                                | Description                                                                                                                                                                                                                                                                                                                                              |
    | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | NEXT_PUBLIC_BASE_PATH                        | This variable is the directory name where NextJS loads the app.<br><br>Set its value to blank `''` when working on development mode in localhost.<br>Set its value to the sub-directory name where the exported NextJS app is to be deployed, i.e. `/<YOUR_REPOSITORY_NAME>` when deploying on a repository (sub-directory) of a root GitHub Pages site. |
-   | NEXT_PUBLIC_BASE_API_URL                     | My Phonebook's server base API url minuse the forward slash.                                                                                                                                                                                                                                                                                             |
+   | NEXT_PUBLIC_BASE_API_URL                     | My Phonebook's server base API url minus the forward slash.                                                                                                                                                                                                                                                                                             |
    | NEXT_PUBLIC_FIREBASE_WEB_API_KEY             | Firebase web API key from the Firebase Project Settings configuration file.                                                                                                                                                                                                                                                                              |
    | NEXT_PUBLIC_FIREBASE_WEB_AUTHDOMAIN          | Firebase web auth domain key from the Firebase Project Settings configuration file.                                                                                                                                                                                                                                                                      |
    | NEXT_PUBLIC_FIREBASE_WEB_PROJECT_ID          | Firebase web project ID from the Firebase Project Settings configuration file.                                                                                                                                                                                                                                                                           |

diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -1,9 +1,8 @@
-version: "3"
 services:
   # NextJS v13 app running on development mode
   my-phonebook-client-dev:
     container_name: my-phonebook-client-dev
-    image: weaponsforge/my-phonebook-client:dev
+    image: weaponsforge/my-phonebook:client
     env_file:
       - ./client/.env
     build:
@@ -19,10 +18,10 @@ services:
     ports:
       - "3000:3000"
 
-  # Express server for hosting KMZ files running in development mode
+  # Express server running in development mode
   my-phonebook-server-dev:
     container_name: my-phonebook-server-dev
-    image: weaponsforge/my-phonebook-server:dev
+    image: weaponsforge/my-phonebook:server
     env_file:
       - ./server/.env
     build:
@@ -32,9 +31,11 @@ services:
     networks:
       - my-phonebook-dev
     volumes:
-      - ./server/src:/opt/server/src
+      - ./server:/opt/server
+      - /opt/server/node_modules
     ports:
       - "3001:3001"
+      - "9229:9229"
 
 networks:
   my-phonebook-dev:

diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml
@@ -1,4 +1,3 @@
-version: "3"
 services:
   # NextJS exported app running on an nginx webserver
   my-phonebook-client-prod:

diff --git a/server/package.json b/server/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "start": "node src/index",
-    "dev": "nodemon src/index.js",
+    "dev": "nodemon --inspect=0.0.0.0:9229 src/index.js",
     "docs": "apidoc -i src/controllers/ -o public/docs/",
     "docs:vercel": "apidoc -i src/controllers/ -o public/",
     "lint": "eslint src --ignore-path .gitignore",