Install Guide

This guide explains how to set up and run Byakko locally for development.

Requirements

The following tools must be installed before running the application locally.

.NET 10 SDK or higher — runtime and build toolchain
JetBrains Rider — recommended IDE (Visual Studio or VS Code also work)
Docker Desktop — required to run PostgreSQL via .NET Aspire

Running locally with Aspire

.NET Aspire orchestrates the API, Admin, Portal, and PostgreSQL database in a single command. Docker Desktop must be running before you start.

dotnet run --project src/MadWorldEU.Byakko.Aspire/Aspire.csproj

This starts the Aspire dashboard (typically at http://localhost:15254) where you can monitor all services, view logs, and inspect traces. The API, Admin, and Portal URLs are listed on the dashboard.

Configuring Aspire parameters

The first time Aspire starts, the dashboard will prompt you to enter the following parameters:

Parameter	Used by
`db-username`	PostgreSQL database
`db-password`	PostgreSQL database
`keycloak-username`	Keycloak admin account
`keycloak-password`	Keycloak admin account

Running tests locally

dotnet test                                                                          # Run all tests
dotnet test tests/MadWorldEU.Byakko.Controller.Api.IntegrationTests/               # API integration tests only
dotnet test tests/MadWorldEU.Byakko.Core.Application.Unittests/                    # Unit tests only
dotnet test tests/MadWorldEU.Byakko.Controller.Api.IntegrationTests/ -- --coverage # With code coverage

The API integration tests spin up an in-process test server via WebApplicationFactory — no running instance or Docker is needed for them.