Skip to content

Commit

Permalink
Add README_dev.md (#1055)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
tnotheis and mergify[bot] authored Feb 20, 2025
1 parent c588039 commit 16a5bc1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions README_dev.md
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion docker-compose/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ services:
- postgres-volume:/var/lib/postgresql/data
ports:
- 5432:5432

rabbitmq:
container_name: bkb-rabbitmq
hostname: rabbitmq
Expand Down

0 comments on commit 16a5bc1

Please sign in to comment.