Quick Start

The quickest way to run the template is to clone the repo and start it with .NET Aspire.

1. Clone the repo

git clone <repo-url>
cd BitzOrcas.Modern

2. Initialise the database

The API host doubles as a schema-initialisation tool. With Aspire running SQL Server and RabbitMQ, initialise everything in one go:

# Start infrastructure first (SQL Server + RabbitMQ)
dotnet run --project src/Hosts/BitzOrcas.AppHost &

# In another terminal — create schema + seed data
dotnet run --project src/Hosts/BitzOrcas.Api -- --seed-demo

Or if you prefer a single-command flow, the --init-schema flag works the same way (schema + audit tables + seed data), then the process exits without entering the web pipeline:

dotnet run --project src/Hosts/BitzOrcas.Api -- --init-schema

Available flags:

3. Run the API

Once the database is ready, start the API (or use the AppHost to start everything together):

# Option A: Standalone API (needs SQL Server + RabbitMQ connection strings configured)
dotnet run --project src/Hosts/BitzOrcas.Api

# Option B: Full Aspire orchestration (SQL Server + RabbitMQ + API)
dotnet run --project src/Hosts/BitzOrcas.AppHost

Once it’s green:

4. Verify the Sandbox module

The template includes a built-in Sandbox module (Notes, Greetings, Ping) to verify everything is working:

# Ping (health check endpoint)
curl https://localhost:7132/api/v1/ping

# Create a greeting
curl -X POST https://localhost:7132/api/v1/greetings \
  -H "Content-Type: application/json" \
  -d '{"name": "World"}'

Next

• Demo Accounts — the seeded platform data and what you’ll find in the database.
• Architecture — the modular monolith + VSA mental model.
• Architecture Diagrams — visual overview of the system.