Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README_dev.md #1055

Merged
merged 7 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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