From 16a5bc10bf86080a1bbe8b4b528a3afe4ad80818 Mon Sep 17 00:00:00 2001
From: Timo Notheisen <65653426+tnotheis@users.noreply.github.com>
Date: Thu, 20 Feb 2025 14:42:28 +0100
Subject: [PATCH] Add README_dev.md (#1055)

* chore: add README_dev-md

* chore: move -f flag to correct place

* chore: add prerquisite for creating the docker volumes

* chore: fix docker compose up command

* chore: change order of dotnet run commands

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
---
 README_dev.md                     | 25 +++++++++++++++++++++++++
 docker-compose/docker-compose.yml |  2 +-
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 README_dev.md

diff --git a/README_dev.md b/README_dev.md
new file mode 100644
index 0000000000..7c46d73e7c
--- /dev/null
+++ b/README_dev.md
@@ -0,0 +1,25 @@
+# Prerequisites
+
+1. Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop)
+2. Download and install the latest version of the [.NET SDK](https://dotnet.microsoft.com/en-us/download)
+3. Use Docker Desktop to create Docker volumes for the database and the blob storage. You can do this via the Docker Desktop UI or by running the following commands:
+    ```bash
+    docker volume create --name=postgres-volume
+    docker volume create --name=azure-storage-emulator-volume
+    ```
+
+# How to run
+
+1. Start the infrastructure by running the following command from the root directory of the repository:
+    ```bash
+    docker compose -f  ./docker-compose/docker-compose.yml up -d
+    ```
+2. Run the application by running the following commands from the root directory of the repository (each in its own terminal):
+
+    ```bash
+    dotnet run --project ./Applications/ConsumerApi/src/ConsumerApi.csproj
+
+    dotnet run --project ./Applications/AdminApi/src/AdminApi/AdminApi.csproj
+
+    dotnet run --project ./Applications/EventHandlerService/src/EventHandlerService/EventHandlerService.csproj
+    ```
diff --git a/docker-compose/docker-compose.yml b/docker-compose/docker-compose.yml
index a45e7be9b9..e33acfec0d 100644
--- a/docker-compose/docker-compose.yml
+++ b/docker-compose/docker-compose.yml
@@ -34,7 +34,7 @@ services:
       - postgres-volume:/var/lib/postgresql/data
     ports:
       - 5432:5432
-  
+
   rabbitmq:
     container_name: bkb-rabbitmq
     hostname: rabbitmq