project.cookiecutter

A template for scaffolding a modern .NET 9 Web API solution with support for:

• OAuth 2.0
• Azure services
• Auditing
• Deployment options for both Aspire and Docker environments

---

🧱 Solution Structure

The generated solution contains the following projects:

Project	Description
Core	Core application logic
Infrastructure	Azure, logging, storage, telemetry, etc.
API	Web API endpoints
Abstractions	Shared contracts and interfaces
HostingApp	Aspire host process (Aspire only)
ServiceDefaults	Aspire extensions and configuration
Database	Entity definitions and configuration
Migrations	EF Core migrations
Tests	Unit/integration test projects

---

🛠 Prerequisites

Required Software

• Cookiecutter

  python3 -m pip install --user cookiecutter

• Docker Desktop
• .NET 9.x SDK

Optional: OAuth & Azure Integration

If you plan to enable OAuth or Azure integrations (Key Vault, Application Insights, Storage, Service Bus), you'll need the following information available for each environment.

OAuth Configuration

• Application Name
• Audience (per environment)
• Domain (per environment)

Azure Configuration

• Tenant ID
• Subscription ID
• Region/Location

Key Vault

• Key Vault Name (per environment)

Storage

• Connection string
• Storage container name
• Storage account name

Service Bus

• Service Bus namespace name

---

🚀 Project Setup

You can generate the solution from either:

• The GitHub repository URL
• A local clone of project.cookiecutter

Example:

cookiecutter gh:your-org/project.cookiecutter
# or
cookiecutter path/to/local/project.cookiecutter

---

🧰 Project Modes

During setup, you'll choose between two project modes:

• Aspire (default)
• Docker

---

🌱 Aspire Mode

Setup Steps

Command Line Setup

1. Create a project folder
2. Navigate to the folder
3. Run Cookiecutter

   cookiecutter gh:your-org/project.cookiecutter

4. Open the generated solution in Visual Studio
5. Run the HostingApp project

Using a Local Clone

1. Clone the project.cookiecutter repository
2. Create a project folder
3. Run Cookiecutter from that path
4. Open the solution in Visual Studio
5. Run the HostingApp project

---

🐳 Docker Mode

Setup Steps

Command Line Setup

1. Create a project folder
2. Navigate to the folder
3. Run Cookiecutter

   cookiecutter gh:your-org/project.cookiecutter

4. Open the solution in Visual Studio
5. Run docker-compose in Debug mode
6. (If using OAuth) Add credentials to Manage User Secrets

Using a Local Clone

1. Clone the project.cookiecutter repository
2. Create a project folder
3. Navigate to the folder
4. Run Cookiecutter
5. Open the solution in Visual Studio
6. Run docker-compose in Debug mode
7. (If using OAuth) Add credentials to Manage User Secrets

---

📄 Additional Info

Each mode (Aspire, Docker) includes a dedicated README.md within its generated folder for environment-specific setup and configuration instructions.