Install

Make sure you’ve got everything in Prerequisites first.

Which path?

Path 1 — Clone the repository

Get the full source as-is, with the original BitzOrcas.Modern project names:

git clone <repo-url> MyApp
cd MyApp
dotnet restore BitzOrcas.Modern.slnx
dotnet run --project src/Hosts/BitzOrcas.AppHost

This is the path for reading the code, contributing, or running the template unchanged.

Path 2 — dotnet new template (recommended for new projects)

Scaffold a fresh, fully renamed project from the template package:

dotnet new install BitzOrcas.Modern.Templates
dotnet new bitzorcas-modern -n MyApp
cd MyApp
dotnet restore MyApp.slnx
dotnet run --project src/Hosts/MyApp.AppHost

The template generates the full solution structure with your project name applied to all hosts, building blocks, and module namespaces.

Verify it’s running

However you installed, launch the project:

dotnet run --project src/Hosts/<YourProject>.AppHost

Aspire brings up SQL Server and RabbitMQ in containers, wires the connection strings, and starts the API. Once it’s green, the API + Scalar docs are available at https://localhost:7132/scalar (or check your launch settings for the actual port).

To initialise the database schema and seed demo data:

dotnet run --project src/Hosts/<YourProject>.Api -- --seed-demo

This creates all tables, audit sharding tables, and populates the 14 platform seed tables (tenants, roles, permissions, languages, countries, general codes, and more).

Next

• Quick Start — the minimal clone-and-run walkthrough.
• Demo Accounts — the seeded platform data and what you can log in as.
• Architecture — the modular monolith + vertical slice mental model.