feat #38: Added Docker Support

Dockerfile

@@ -0,0 +1,17 @@
+# Stage 0, "build-stage", based on Node.js, to build and compile the frontend
+FROM node:18 AS build-stage
+ARG GITHUB_TOKEN
+ARG BASE_HREF
+ARG CONFIGURATION
+RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node/app
+WORKDIR /home/node/app
+COPY package*.json ./
+RUN npm ci
+COPY --chown=node:node *.json *.js ./
+COPY --chown=node:node src/ ./src/
+RUN npm run build -- --configuration="$CONFIGURATION" --base-href="$BASE_HREF"
+
+# Stage 1, based on Nginx, to have only the compiled app, ready for production with Nginx
+FROM nginx:latest
+COPY --from=build-stage /home/node/app/dist/viewer-app/ /usr/share/nginx/html/
+COPY ./nginx.conf /etc/nginx/conf.d/default.conf

README.md

@@ -1,14 +1,83 @@
-# SITMUN Viewer App
-A map viewer application for the SITMUN platform.
+# SITMUN Viewer Application
 
-## Requirements
+The SITMUN Viewer Application is a web-based application built using TypeScript, JavaScript, npm, and Angular.
 
-- TBD
+## Docker Support
 
-## Available deployments
+The application is containerized using Docker, as defined in the Dockerfile. The Dockerfile is divided into two stages:
 
-- TBD
+1. **Build Stage**: Based on Node.js, this stage is responsible for building and compiling the frontend of the application.
+   It uses npm to manage dependencies and Angular for building the application.
+2. **Production Stage**: Based on Nginx, this stage serves the compiled application.
+   The compiled application from the build stage is copied into the Nginx container and served from the `/usr/share/nginx/html/` directory.
 
-## Developer documentation
+### Dockerfile Build Arguments
 
-- TBD
+The Dockerfile for the SITMUN Viewer Application takes three arguments during the build stage:
+
+- `BASE_HREF`: Specifies the base URL for the application, used by Angular for routing.
+- `CONFIGURATION`: Specifies the build configuration for the Angular application (i.e. `testdeployment` and `development`).
+
+### Building the Docker Image
+
+To build the Docker image for the SITMUN Viewer Application, use the `docker build` command.
+This command includes the image name and any necessary build arguments.
+
+Example command to build the Docker image:
+
+```bash
+docker build -t sitmun-viewer-app --build-arg BASE_HREF=/ --build-arg CONFIGURATION=testdeployment .
+```
+
+Adjust the `BASE_HREF` and `CONFIGURATION` as needed.
+
+### Starting the Application with Docker
+
+To start the application, run the following command in the terminal:
+
+```bash
+docker run -p 80:80 sitmun-viewer-app 
+```
+
+This command will start the SITMUN Viewer Application and map port 80 in the container to port 80 on the host machine.
+The application should now be accessible at http://localhost on your machine.
+
+## Docker Compose Support
+
+To deploy the SITMUN Viewer Application using Docker Compose, create a `docker-compose.yml file that defines the services for your application.
+
+### Steps to Create a docker-compose.yml File
+
+1. Create a `docker-compose.yml` file in the root directory of your project.
+2. Define a service for the SITMUN Viewer Application in the `docker-compose.yml` file.
+   This service should use the Docker image built from the `Dockerfile`, specify the ports to expose, and include any necessary environment variables or build arguments.
+3. Start your application by running the `docker-compose up command in the terminal.
+
+### Example docker-compose.yml File
+
+```yaml
+version: '3.8'
+services:
+  sitmun-viewer-app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        BASE_HREF: /
+        CONFIGURATION: testdeployment
+    ports:
+      - "80:80"
+ ```
+
+Adjust the `BASE_HREF` and `CONFIGURATION` as needed.
+
+### Starting the Application with Docker Compose
+
+To start the application, run the following command in the terminal:
+
+```bash
+docker-compose up
+```
+
+This command will start the SITMUN Viewer Application and map port 80 in the container to port 80 on the host machine.
+The application should now be accessible at http://localhost on your machine.

nginx.conf

@@ -0,0 +1,9 @@
+server {
+  listen 80;
+
+  location / {
+    root /usr/share/nginx/html;
+    index index.html index.htm;
+    try_files $uri /index.html =404;
+  }
+}