feat(KUI-1542): update dependencies (upgrade node version from 18 to 20) & improve the code for running locally using docker

.gitignore

@@ -34,6 +34,7 @@ dist
 
 # Docker
 *.env*
+Dockerfile-dev
 
 # KTH Node Web Common imported files
 server/views/system/error.handlebars

Dockerfile

@@ -1,4 +1,4 @@
-FROM kthregistry.azurecr.io/kth-nodejs-18:latest
+FROM kthregistry.azurecr.io/kth-nodejs-20:latest
 LABEL maintainer="KTH-studadm [email protected]"
 
 WORKDIR /application

README.md

@@ -125,6 +125,40 @@ Add to .vscode file launch.json:
 }
 ```
 
+## Run Locally Using Docker
+
+You can run the project locally using Docker for an isolated and consistent environment. Follow these steps:
+
+#### Build Docker Image
+
+First, build the Docker image by running the following command:
+
+If you are using mac change `docker build -f Dockerfile-dev -t "$IMAGE_NAME"` with `docker build --platform linux/arm64/v8 -f Dockerfile-dev -t "$IMAGE_NAME"`.
+
+
+```sh
+npm run docker:build
+```
+
+This will execute the `docker-build-image.sh` script in development mode `(dev)` this script will create Dockerfile-dev file which will be used for running the project locally using docker.
+
+#### Run Docker Container
+
+After the image has been built, you can start the Docker container using the following command:
+
+```sh
+npm run docker:run
+```
+
+This will execute the `docker-run-image.sh` script in development mode `(dev)`, running the application locally in Docker.
+
+The application now will be accessible at http://localhost:3000/student/kurser/kurs/:courseCode.
+
+#### Notes
+
+- Run `az acr login --name kthregistry` before running the scripts.
+- Ensure your .env file is properly set up in the project root to provide the necessary environment variables to the Docker container.
+
 ## Deploy
 
 The deployment process is described in [Build, release, deploy](https://confluence.sys.kth.se/confluence/x/aY3_Ag). Technical details, such as configuration, is described in [How to deploy your 🐳 application using Cellus-Registy](https://gita.sys.kth.se/Infosys/cellus-registry/blob/master/HOW-TO-DEPLOY.md) and [🔧 How To Configure Your Application For The Pipeline](https://gita.sys.kth.se/Infosys/cellus-registry/blob/master/HOW-TO-CONFIGURE.md).

docker-build-image.sh

@@ -13,23 +13,30 @@ echoYellow "|    Building the Docker image for development env       |"
 echoYellow "|--------------------------------------------------------|\n"
 
 IMAGE_NAME="kursinfo-web-image"
+DOCKERFILE="Dockerfile-dev"
 
 
 if [ "$ENV" == "dev" ]; then
 
   echo
-  echoYellow "  1. Stop previous Docker image: a name tag is $IMAGE_NAME\n"
+  echoYellow "  1. Creating Dockerfile-dev for development environment\n"
+
+  cp Dockerfile "$DOCKERFILE"
+  sed -i '' 's/CMD \["npm", "start"\]/CMD ["npm", "run", "docker:start"]/g' "$DOCKERFILE"
+
+  echo
+  echoYellow "  2. Stop previous Docker image: a name tag is $IMAGE_NAME\n"
   docker stop "$IMAGE_NAME"
 
   echo
-  echoYellow "  2. Remove previous Docker image: a name tag is $IMAGE_NAME\n"
+  echoYellow "  3. Remove previous Docker image: a name tag is $IMAGE_NAME\n"
   docker rmi "$IMAGE_NAME"
 
   echo
-  echoYellow "  3. Build Docker image: a name tag is $IMAGE_NAME\n"
+  echoYellow "  4. Build Docker image: a name tag is $IMAGE_NAME\n"
   docker build -f Dockerfile-dev -t "$IMAGE_NAME" .
 
   echo
-  echoYellow "  4. List images\n"
+  echoYellow "  5. List images\n"
   docker images
 fi

package.json

@@ -14,6 +14,7 @@
     "build-dev": "bash ./build.sh dev",
     "docker:build": "bash ./docker-build-image.sh dev",
     "docker:run": "bash ./docker-run-image.sh dev",
+    "docker:start": "bash -c 'cat /KTH_NODEJS; NODE_ENV=development node app.js'",
     "test": "NODE_ENV=test jest",
     "test-win": "cross-env NODE_ENV=test jest",
     "test:watch": "jest --watch",
@@ -102,7 +103,7 @@
     "webpack-cli": "^5.1.4"
   },
   "engines": {
-    "node": "18"
+    "node": "20"
   },
   "jshintConfig": {
     "maxerr": 5