Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mathialm authored and GitHub Enterprise committed Feb 25, 2025
1 parent 4811bb2 commit e7fa863
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<username>/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 <compose_file> --verbose config
```

Build and run containers defined in configuration file
```console
$ docker-compose -f <compose_file> up --build -d
```
Expand Down

0 comments on commit e7fa863

Please sign in to comment.