docs: updated readme with more information for reverse-proxy

Author: karl-cardenas-coding

.github/workflows/release.yaml

@@ -64,16 +64,6 @@ jobs:
           push: true
           tags: ghcr.io/${{ github.repository }}:${{steps.version.outputs.VERSION}}
 
-      - name: "release"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-              npm install @semantic-release/exec -D
-              npm install @semantic-release/changelog -D
-              npm install @semantic-release/github -D
-              npm install @semantic-release/git -D
-              npx semantic-release
-
   docker-reverse-proxy:
     name: "Docker w/Proxy image"
     runs-on: ubuntu-latest
@@ -129,4 +119,26 @@ jobs:
             file: Dockerfile.Caddy
             platforms: linux/amd64,linux/arm64
             push: true
-            tags: ghcr.io/${{ github.repository }}:${{steps.version.outputs.VERSION}}-proxy
+            tags: ghcr.io/${{ github.repository }}:${{steps.version.outputs.VERSION}}-proxy
+
+  release:
+    name: "Release"
+    needs: [docker,docker-reverse-proxy]
+    runs-on: ubuntu-latest
+    steps:
+      - id: checkout
+        name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: "release"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

Makefile

@@ -1,14 +1,16 @@
+.PHONY: build
 
-build: 
+build: clean
+	@echo "Building..."
 	npm run build
 
 start:
 	@echo "Starting..."
 	npm run start
 
-start-prod: clean
+start-prod: clean build
 	@echo "Starting production server"
-	npm run start-prod
+	npm run server-prod
 
 clean:
 	@echo "Cleaning..."

README.md

@@ -37,6 +37,7 @@ Hello Universe accepts the following environment variables:
 |-------------|----------------------------------------------------|-----------|
 | API_URI     | The fully qualified hostname and port of the API server, such as `http://localhost:3000`    | "" |
 | API_VERSION  | The API version number    | `1` |
+| REVERSE_PROXY| Enable to use the reverse proxy. This value is set to `true` in the proxy container image. |`false`|
 
 
 ## Connecting to API Server
@@ -45,14 +46,25 @@ Hello Universe's capabilities can be expanded if connected to the [Hello Univers
 To connect Hello Universe to the API server, provide the API server's fully qualified hostname and port as an environment variable value.
 Be aware that the API server requires an available Postgres database. Checkout [Hello Universe DB](https://github.com/spectrocloud/hello-universe-db) for a dockerized Postgres instance ready for integration with the Hello Universe API.
 
+
 ```shell
 API_URI=http://localhost:3000
 ```
 
 If you are using the Docker image then use the `-e` flag parameter.
 
 ```shell
-docker run -p 8080:8080 -e API_URI=http://localhost:3000 ghcr.io/spectrocloud/hello-universe:1.0.4
+docker run -p 8080:8080  -e API_URI=http://localhost:3000 ghcr.io/spectrocloud/hello-universe:1.0.4
+```
+
+### Reverse Proxy
+
+A Docker container with a reverse proxy for `http://0.0.0.0:3000` is available. The reverse proxy is usefull for scenarios when you need to deploy the 
+hello universe application into a Kubernetes cluster or similar architectures and need the UI to route requests internal to the hosting platform 
+to reach the API. **The reverse proxy expects the API to be listening on port `3000`.**
+
+```shell
+docker run -p 8080:8080 -e API_URI="http://myprivate.api.address.example:3000"  ghcr.io/spectrocloud/hello-universe:1.0.5-proxy
 ```
 
 # Development
@@ -67,6 +79,11 @@ REACT_APP_API_VERSION=1
 The `.env` file is how you point to the local development API server. Otherwise, you will use the global API counter.
 
 
+## Clean
+To remove the build folder use the command `make clean`
+
+## Build
+To build the hosting assets use the command `make build`
 ### Development Server
 To start the local development server without a proxy use the command `make start`.
 

local-caddyfile

@@ -4,18 +4,16 @@
 	try_files {path} /index.html
 	file_server
 	header Access-Control-Allow-Origin *
-   	header Access-Control-Allow-Methods *
+	header Access-Control-Allow-Methods *
 
 	log {
 		output file caddy.log {
-            roll_size 1gb
-            roll_keep 5
-            roll_keep_for 720h
-        }
+			roll_size 1gb
+			roll_keep 5
+			roll_keep_for 720h
+		}
 		format json {
-            time_format wall
-        }
+			time_format wall
+		}
 	}
 }
-
-