From 2a9285a2ba413aff390ba31dd388e52abc24a855 Mon Sep 17 00:00:00 2001
From: Michael Reimsbach <MR201190@gmail.com>
Date: Thu, 11 Jul 2024 16:02:52 +0200
Subject: [PATCH 1/2] chore(doc): add setup section

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index be7cc0ef..fe1da52d 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,23 @@ For a detailed understanding of the system's architecture and design, refer to t
 
 ## Requirements and Setup
 
-*Insert a short description what is required to get your project running...*
+The `docker-compose.yml` file defines two profiles: `db` for the `heureka-db` service and `heureka` for the `heureka-app` service.
+To start a specific service with its profile, use the --profile option followed by the profile name.
+
+For example, to start the heureka-db service, run:
+```
+docker-compose --profile db up
+```
+
+And to start the heureka-app service, run:
+```
+docker-compose --profile heureka up
+```
+
+To start both services at the same time, run:
+```
+docker-compose --profile db --profile heureka up
+```
 
 ## Support, Feedback, Contributing
 

From d5ebfded6a03ad0ca414a741f71ce2b8e3e986e7 Mon Sep 17 00:00:00 2001
From: Michael Reimsbach <MR201190@gmail.com>
Date: Fri, 12 Jul 2024 13:32:58 +0200
Subject: [PATCH 2/2] chore(doc): Update README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index fe1da52d..327ae797 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,35 @@ For a detailed understanding of the system's architecture and design, refer to t
 
 ## Requirements and Setup
 
+The application can be configured using environment variables. These variables are stored in a `.env` file at the root of the project.
+For configuring tests, there is a separate `.test.env` file.
+
+Here's a basic example of what the .env file could look like:
+
+```
+DB_USER=my_username
+DB_PASSWORD=my_password
+DB_ROOT_PASSWORD=my_password
+DB_NAME=heureka
+DB_ADDRESS=localhost
+DB_PORT=3306
+DB_SCHEMA=internal/database/mariadb/init/schema.sql
+
+DB_CONTAINER_IMAGE=mariadb:latest
+
+DOCKER_IMAGE_REGISTRY=hub.docker.com
+
+DOCKER_CREDENTIAL_STORE=docker-credential-desktop
+
+LOG_PRETTY_PRINT=true
+
+LOCAL_TEST_DB=true
+
+SEED_MODE=false
+```
+
+### Docker
+
 The `docker-compose.yml` file defines two profiles: `db` for the `heureka-db` service and `heureka` for the `heureka-app` service.
 To start a specific service with its profile, use the --profile option followed by the profile name.
 
@@ -58,6 +87,14 @@ To start both services at the same time, run:
 docker-compose --profile db --profile heureka up
 ```
 
+### Makefile
+
+Alternatively, the application can be started by using the provided Makefile:
+
+```
+make start-all-heureka
+```
+
 ## Support, Feedback, Contributing
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/<your-project>/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).