docs: added documentation

Author: Ivica Matic

.github/workflows/build-dist-version-on-release.yaml

@@ -25,28 +25,25 @@ jobs:
 
   build-distribution-version-into-docker-container:
     runs-on: ubuntu-latest
+    # environment: environment_name # use if you want to use a specific environment on repository level
     steps:
-      - uses: actions/checkout@v4
-        name: Checkout repository
-
       - name: Check if secrets exist
         run: |
           if [[ -z "${{ secrets.DOCKER_LOGIN_SERVER }}" || -z "${{ secrets.DOCKER_USERNAME }}" || -z "${{ secrets.DOCKER_PASSWORD }}" ]]; then
             echo "Error: Secrets not found."
             exit 1
           fi
-
+      - uses: actions/checkout@v4
+        name: Checkout repository
       - uses: docker/login-action@v2
         name: Log in to the Container registry
         with:
           registry: ${{ secrets.DOCKER_LOGIN_SERVER}}
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
-
       - uses: docker/setup-buildx-action@v2
         name: Set up Docker Buildx
         id: buildx
-
       - uses: docker/build-push-action@v4
         name: Build and push Docker image
         with:

README.md

@@ -1,3 +1,16 @@
+# Github actions Node 20 react app build template
+This is a template repoistory set up that it builds react spa application using github actions on every new release. The build is done on ubuntu-latest runner and uses node 20. The build is done using `npm ci` and `npm run build`. In addition to saving the built output to artifact, 2nd job builds the static html/css/js and pushes it to the nginx container togather with nginx config for spa so that it can be
+hosted using anything that can run a docker container.
+
+## Requirements for docker container build
+You need to have the following secrets set up in your github either on organization or repository level. If you are using repository level secrets with environments, uncomment the `environment` section in the github workflow file and replace it with the name of your environment.
+
+| Secret Name | Description |
+| ----------- | ----------- |
+| DOCKER_LOGIN_SERVER | The server URL of the docker registry.|
+| DOCKER_USERNAME | The username to login to the docker registry.|
+| DOCKER_PASSWORD | The password to login to the docker registry.|
+
 # Getting Started with Create React App
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).