From e7fa86375698c6a17894bd493e4d82707e125e54 Mon Sep 17 00:00:00 2001 From: Mathias Lundteigen Mohus Date: Tue, 25 Feb 2025 11:31:17 +0100 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1224043..3dce3ce 100644 --- a/README.md +++ b/README.md @@ -58,14 +58,29 @@ Windows hosts must use Education or more advanced versions to run Docker \ Download: [https://innsida.ntnu.no/wiki/-/wiki/English/Microsoft+Windows+10](https://innsida.ntnu.no/wiki/-/wiki/English/Microsoft+Windows+10) ### Install: +In your github, fork this repository ([https://git.ntnu.no/mathialm/secfit](https://git.ntnu.no/mathialm/secfit)) ```console -$ git clone https://git.ntnu.no/mathialm/secfit +$ git clone https://git.ntnu.no//secfit $ cd secfit ``` ### Run: +In this project, we have three docker-compose files you can use to set up the containers. + +`docker-compose.dev.yml` is used to make the backend, frontend, and gateway containers with all ports open. These are intended to be used as development containers (i.e., enabling CI/CD and updating as code is pushed). + +`docker-compose.stag.yml` is used to make the backend with a different configuration (in [./backend/tests/Dockerfile.test](./backend/tests/Dockerfile.test)). This is intended to be used for testing your code and should only run when tests are run. You can expand this to also set up the frontend and gateway if implemented tests require it. + +`docker-compose.yml` is used to make the backend, frontend, and gateway containers, with only the ports on the gateway open. These are intended to be used as production containers and should, as such, ensure persistent volumes and proper migration where needed. + +Verify compose configuration file: +```console +$ docker compose -f --verbose config +``` + +Build and run containers defined in configuration file ```console $ docker-compose -f up --build -d ```