Hexagonal architecture solution template

This repository provides a reusable .NET template package to bootstrap projects using Hexagonal Architecture (Ports and Adapters) and modern engineering practices.

It includes six templates for different scopes: a simple application, a full application, a BFF-focused application, a Blazor Web UI application, a simple Blazor Web UI application, and a contracts-only package.

Table of contents

• What this project provides
• Available templates
• Template documentation
• Technologies included
• Quick start
• Database migrations
• Template options and help
• Update or uninstall
• Recommendation
• Official template docs
• Contributing

What this project provides

The package GPreviatti.Template.Hexagonal.Solution lets you quickly create solutions with:

• clear layering and separation of concerns;
• HTTP and gRPC integration patterns;
• observability and test-first tooling support;
• examples that help accelerate initial development.

Available templates

• hexagonal-solution-simple: streamlined hexagonal solution with Core, Infrastructure, and WebApp layers plus unit/integration/load test projects — ideal for straightforward applications.
• hexagonal-solution-full: complete hexagonal solution with Domain, Application, Infrastructure, WebApp, and test/load test projects.
• hexagonal-solution-bff: Backend-for-Frontend oriented solution with HTTP/gRPC adapters, integration tests, and load tests.
• hexagonal-solution-webui: Blazor Web App oriented solution with contracts/infrastructure separation and bUnit component unit tests.
• hexagonal-solution-simple-webui: streamlined Blazor Web UI solution with Core, Infrastructure, and WebUI layers plus unit and E2E test projects.
• hexagonal-solution-contracts: lightweight contracts package for shared DTOs, request/response models, and protobuf definitions.

Template documentation

Each template has its own README with architecture details, structure, and helper commands:

• Simple template: templates/Simple/Readme.md
• Full template: templates/Full/Readme.md
• BFF template: templates/Bff/Readme.md
• Web UI template: templates/WebUi/Readme.md
• Simple Web UI template: templates/SimpleWebUi/Readme.md
• Contracts template: templates/Contracts/Readme.md

Technologies included

• FluentValidation
• OpenTelemetry
• Entity Framework Core
• gRPC / Protobuf
• xUnit, Moq, AutoFixture
• Docker and Docker Compose
• k6 (load testing)
• Stryker (mutation testing)
• GitHub Actions
• Hybrid cache
• RabbitMQ

Quick start

Install the template package:

dotnet new install GPreviatti.Template.Hexagonal.Solution

Create a new solution from each template:

dotnet new hexagonal-solution-simple -n HexagonalSolution
dotnet new hexagonal-solution-full -n HexagonalSolution
dotnet new hexagonal-solution-bff -n HexagonalSolution
dotnet new hexagonal-solution-webui -n HexagonalSolution
dotnet new hexagonal-solution-simple-webui -n HexagonalSolution
dotnet new hexagonal-solution-contracts -n HexagonalSolution

Start the backing services (the db-migrate container will apply all EF Core migrations and seed data automatically):

docker compose -f docker-compose-local.yml up -d

To add a new migration after changing the domain model:

dotnet ef migrations add <MigrationName> \
  --project src/Infrastructure \
  --startup-project src/WebApp \
  --output-dir Data/Migrations

The next docker compose up will pick up and apply the new migration automatically. For local development without Docker, run:

dotnet ef database update -p src/Infrastructure/ \
  --connection "Host=127.0.0.1;Port=5432;Database=OrderDb;Username=postgres;Password=cY5VvZkkh4AzES"

Database migrations

The Simple and Full templates use EF Core migrations for all schema changes and seed data. A dedicated db-migrate Docker service (built from Dockerfile.migrate) runs dotnet ef database update on every docker compose up, so the database is always in sync with the codebase — no manual SQL files to maintain.

What	How
Schema changes and seed data	EF Core migration classes in src/Infrastructure/Data/Migrations/
Applied automatically	db-migrate service on docker compose up
Applied manually (no Docker)	dotnet ef database update -p src/Infrastructure/ --connection "<connection-string>"
Create a new migration	dotnet ef migrations add <Name> --project src/Infrastructure --output-dir Data/Migrations
Rollback	dotnet ef database update <PreviousMigrationName> -p src/Infrastructure/ --connection "<connection-string>"

Seed data is embedded as regular EF Core migrations (e.g., OrderSeed, NotificationSeed) with proper Up() and Down() methods, giving full rollback support alongside schema migrations.

Template options and help

Use -h to list available options for each template:

dotnet new hexagonal-solution-simple -h
dotnet new hexagonal-solution-full -h
dotnet new hexagonal-solution-bff -h
dotnet new hexagonal-solution-webui -h
dotnet new hexagonal-solution-simple-webui -h
dotnet new hexagonal-solution-contracts -h

Update or uninstall

Update to the latest published template version:

dotnet new update GPreviatti.Template.Hexagonal.Solution

Uninstall the template package:

dotnet new uninstall GPreviatti.Template.Hexagonal.Solution

Recommendation

Keep the provided Order sample scenario in place until your own domain scenario is implemented. It serves as a reference for architecture, project organization, and tests.

Official template docs

https://github.com/dotnet/templating/wiki

Contributing

Have a feature request or found a bug? We'd love to hear from you!

• Report a Bug
• Request a Feature