Merge pull request #85 from ciatph/dev

v1.1.6

Author: ciatph

.github/workflows/pull-images.yml

@@ -0,0 +1,36 @@
+# 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 App 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: Create temporary env variables
+        run: |
+          cp client/.env.example client/.env
+          cp server/.env.example server/.env
+
+      - name: Pull App Image
+        run: |
+          sed -i "s/:latest/:$LATEST_TAG/" docker-compose.app.yml
+          docker compose -f docker-compose.app.yml pull
+
+      - name: Pull Development Images
+        run: docker compose -f docker-compose.dev.yml pull

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Deploy to Development Environment
+name: Deploy to Production Environment
 
 # This workflow will trigger on any tag/release created on *any* branch
 # Make sure to create tags/releases only from the "master" branch for consistency

.gitignore

@@ -1,3 +1,2 @@
 .env
-.vscode
 *.zip

.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Docker: Attach to Node",
+      "port": 9229,
+      "address": "localhost",
+      "localRoot": "${workspaceFolder}//server",
+      "remoteRoot": "/opt/server",
+      "protocol": "inspector",
+      "restart": true,
+      "sourceMaps": true,
+      "skipFiles": ["<node_internals>/**"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}\\server\\src\\index.js",
+      "envFile": "${workspaceFolder}/server/.env"
+    }
+  ]
+}

README.md

@@ -14,8 +14,9 @@ A basic web app client in the **/client** directory will show basic API usage an
   - [Docker Dependencies](#docker-dependencies)
   - [Docker for Localhost Development](#docker-for-localhost-development)
   - [Docker for Production Deployment](#docker-for-production-deployment)
-- [Pre-built Server Docker Image](#pre-built-server-docker-image-app)
-- [Pre-built Server Docker Image](#pre-built-server-docker-image-client--server-development)
+- [Pre-built Server Docker Image (App)](#pre-built-server-docker-image-app)
+- [Pre-built Server Docker Image (Client + Server) Development](#pre-built-server-docker-image-client--server-development)
+- [Deploy with GitHub Actions](#deploy-with-gitHub-actions)
 - [References](#references)
 
 ## Requirements
@@ -56,6 +57,8 @@ A basic web app client in the **/client** directory will show basic API usage an
    |EMAIL_WHITELIST| Comma-separated email addresses linked to Firebase Auth UserRecords that are not allowed to be deleted or updated (write-protected)<br><br>Default value is `[email protected]`|
    |ALLOW_CORS|Allow Cross-Origin Resource Sharing (CORS) on the API endpoints.<br><br>Default value is `1`, allowing access to domains listed in `ALLOWED_ORIGINS`. Setting to `0` will make all endpoints accept requests from all domains, including Postman.|
    |ALLOW_AUTH|Restrict access to the `POST`, `PATCH` and `DELETE` API endpoints by allowing signed-in Firebase user Bearer Authorization (Firebase token) checking.<br><br>Retrieve the signed-in Firebase token by signing in a user using the Firebase Web JS SDK `signInWithEmailAndPassword()` method, then retrieve the latest token value using `getIdTokenResult()`.<br><br>Default value is `1`. Setting to `0` will disable Bearer Authorization checking on the listed API endpoints.|
+   | CHOKIDAR_USEPOLLING | Enables hot reload on `nodemon` running inside Docker containers on a Windows host. Set it to true if running Docker Desktop with WSL2 on a Windows OS. |
+   | CHOKIDAR_INTERVAL | Chokidar polling interval. Set it along with `CHOKIDAR_USEPOLLING=true` if running Docker Desktop with WSL2 on a Windows OS. The default value is `1000`. |
 
 ### client
 
@@ -82,6 +85,7 @@ A basic web app client in the **/client** directory will show basic API usage an
    | REACT_APP_FIREBASE_MESSAGING_SENDER_ID | Firebase web messaging sender ID from the Firebase Project Settings configuration file. |
    | REACT_APP_FIREBASE_APP_ID | Firebase web web app key from the Firebase Project Settings configuration file. |
    | REACT_APP_FIREBASE_MEASUREMENT_ID | Firebase web measurement ID from the Firebase Project Settings configuration file. |
+   | WATCHPACK_POLLING | Enables hot reload on React apps running inside Docker containers on a Windows host. Set it to `true` if running Docker Desktop with WSL2 on a Windows OS. |
 
 4. Run the app in development mode.
 `npm start`
@@ -234,8 +238,8 @@ The server also serves the pre-built `client` website from a static directory us
 ### Steps
 
 1. Pull the (production) **/server** [Docker image](https://hub.docker.com/repository/docker/ciatphdev/firebase-users-app) from Docker Hub.
-   - Find the latest version tag from https://hub.docker.com/r/ciatphdev/firebase-users-app, i.e., `v1.1.5`
-   - `docker pull ciatphdev/firebase-users-app:v1.1.5`
+   - Find the latest version tag from https://hub.docker.com/r/ciatphdev/firebase-users-app, i.e., `v1.1.6`
+   - `docker pull ciatphdev/firebase-users-app:v1.1.6`
 2. Create a `.env` file.
    - Read [**Installation - server #3**](#server) for more information.
    - Replace the variables accordingly in the `.env` file. Set `ALLOW_CORS=0` to allow `Same Origin` requests. Read [**Option #2 - Client and Server Bundled in (1) Image and Service**](#option-2---client-and-server-bundled-in-1-image-and-service) for more information.
@@ -252,7 +256,7 @@ The server also serves the pre-built `client` website from a static directory us
    docker run -it --rm \
       --env-file .env \
       -p 3001:3001 \
-      ciatphdev/firebase-users-admin-app:v1.1.5
+      ciatphdev/firebase-users-admin-app:v1.1.6
    ```
 4. Run a script in the container to create the default `[email protected]` account, if it does not yet exist in the Firestore database.
    `docker exec -it firebase-users-admin-app npm run seed`
@@ -293,6 +297,40 @@ https://hub.docker.com/r/ciatphdev/firebase-users-server/tags
    docker run -it --rm --env-file .env -p 3001:3001 ciatphdev/firebase-users-server:dev
    ```
 
+## Deploy with GitHub Actions
+
+### Requirements
+
+1. Firebase project
+   - with Authentication (Email/Password) activated
+2. Docker Hub account
+
+### Steps
+
+1. Create the following GitHub Secrets:<br>
+   **client** `.env` variables
+   ```
+   REACT_APP_BASE_URL
+   REACT_APP_FIREBASE_API_KEY
+   REACT_APP_FIREBASE_AUTHDOMAIN
+   REACT_APP_FIREBASE_PROJECT_ID
+   REACT_APP_FIREBASE_STORAGE_BUCKET
+   REACT_APP_FIREBASE_MESSAGING_SENDER_ID
+   REACT_APP_FIREBASE_APP_ID
+   REACT_APP_FIREBASE_MEASUREMENT_ID
+   ```
+
+   **Docker Hub Account**
+   | GitHub Secret | Description |
+   | --- | --- |
+   | DOCKERHUB_USERNAME | Docker Hub username |
+   | DOCKERHUB_TOKEN | Deploy token for the Docker Hub account |
+
+2. Create Release/Tag from the `master` branch to trigger deployment to the **production** environment:
+   - Deploy front end (React) to Firebase Hosting
+   - Build and push Docker images to Docker Hub
+
+3. Inspect the contents of the `.github/workflows/release.yml` for reference.
 
 ## References
 

client/.env.example

@@ -5,4 +5,6 @@ REACT_APP_FIREBASE_PROJECT_ID=users-admin-firebase
 REACT_APP_FIREBASE_STORAGE_BUCKET=users-admin-firebase.appspot.com
 REACT_APP_FIREBASE_MESSAGING_SENDER_ID=761515421472
 REACT_APP_FIREBASE_APP_ID=1:761515421472:web:d7c737ba274515297f3145
-REACT_APP_FIREBASE_MEASUREMENT_ID=G-ZCWY6YX0P0
+REACT_APP_FIREBASE_MEASUREMENT_ID=G-ZCWY6YX0P0
+# Uncomment this line if using Docker Desktop and WSL2 on Windows OS
+# WATCHPACK_POLLING=true

docker-compose.dev.yml

@@ -34,6 +34,7 @@ services:
       - /opt/server/node_modules
     ports:
       - "3001:3001"
+      - "9229:9229"
 
 networks:
   firebase-users-dev:

server/.env.example

@@ -4,3 +4,6 @@ FIREBASE_PRIVATE_KEY=PRIVATE-KEY-FROM-FIREBASE-SERVICE-ACCOUNT-JSON-WITH-DOUBLE-
 EMAIL_WHITELIST=[email protected]
 ALLOW_CORS=1
 ALLOW_AUTH=1
+# Uncomment these 2 CHOKIDAR lines if running Express on Docker Desktop and WSL2 on Windows OS
+# CHOKIDAR_USEPOLLING=true
+# CHOKIDAR_INTERVAL=1000

server/package.json

@@ -11,7 +11,7 @@
     "pm2": "pm2 start process.json --no-daemon",
     "start": "node src/index.js",
     "build": "npm run gen:docs",
-    "dev": "nodemon watch src/index.js",
+    "dev": "nodemon --inspect=0.0.0.0:9229 src/index.js",
     "seed": "node src/scripts/seeder.js",
     "lint": "eslint src --ignore-path .gitignore",
     "lint:fix": "eslint --ignore-path .gitignore --fix src",

server/src/utils/templates/header.md

@@ -22,8 +22,8 @@ firebase-users-admin's server component, hosting all the listed endpoints below
 The server also serves a pre-built [`client`](https://github.com/ciatph/firebase-users-admin/tree/dev/client) website from a static directory using the `express.static()` middleware, following the build instructions from [**Option #2 - Client and Server Bundled in (1) Image and Service**](https://github.com/ciatph/firebase-users-admin#option-2---client-and-server-bundled-in-1-image-and-service).
 
 1. Pull the (production) **/server** [Docker image](https://hub.docker.com/repository/docker/ciatphdev/firebase-users-app) from Docker Hub.
-   - Find the latest version tag from https://hub.docker.com/r/ciatphdev/firebase-users-app, i.e., `v1.1.5`
-   - `docker pull ciatphdev/firebase-users-app:v1.1.5`
+   - Find the latest version tag from https://hub.docker.com/r/ciatphdev/firebase-users-app, i.e., `v1.1.6`
+   - `docker pull ciatphdev/firebase-users-app:v1.1.6`
 2. Create a `.env` file.
    - Read [**Installation - server #3**](https://github.com/ciatph/firebase-users-admin#server) for more information.
    - Replace the variables accordingly in the `.env` file. Set `ALLOW_CORS=0` to allow `Same Origin` requests. Read [**Option #2 - Client and Server Bundled in (1) Image and Service**](https://github.com/ciatph/firebase-users-admin#option-2---client-and-server-bundled-in-1-image-and-service) for more information.
@@ -40,7 +40,7 @@ The server also serves a pre-built [`client`](https://github.com/ciatph/firebase
    docker run -it --rm \
       --env-file .env
       -p 3001:3001 \
-      ciatphdev/firebase-users-admin-app:v1.1.5
+      ciatphdev/firebase-users-admin-app:v1.1.6
    ```
 4. Run a script in the container to create the default `[email protected]` account, if it does not yet exist in the Firestore database.
    `docker exec -it firebase-users-admin-app npm run seed`