Clean.Architecture.Solution.Template 10.2.0

Clean Architecture Solution Template

The goal of this template is to provide a straightforward and efficient approach to enterprise application development, leveraging the power of Clean Architecture and ASP.NET Core. Using this template, you can effortlessly create a Single Page App (SPA) with ASP.NET Core and Angular or React, while adhering to the principles of Clean Architecture. Getting started is easy - simply install the .NET template (see below for full details).

If you find this project useful, please give it a star. Thanks! ⭐

Getting Started

The following prerequisites are required to build and run the solution:

• .NET 10.0 SDK (latest version)
• Node.js (latest LTS, only required if you are using Angular or React)

The easiest way to get started is to install the .NET template:

dotnet new install Clean.Architecture.Solution.Template

Once installed, create a new solution using the template. You can choose to use Angular, React, or create a Web API-only solution. Specify the client framework using the -cf or --client-framework option, and provide the output directory where your project will be created. Here are some examples:

To create a Single-Page Application (SPA) with Angular and ASP.NET Core:

dotnet new ca-sln --client-framework Angular --output YourProjectName

To create a SPA with React and ASP.NET Core:

dotnet new ca-sln -cf React -o YourProjectName

To create a ASP.NET Core Web API-only solution:

dotnet new ca-sln -cf None -o YourProjectName

Launch the app:

cd src/Web
dotnet run

To learn more, run the following command:

dotnet new ca-sln --help

You can create use cases (commands or queries) by navigating to ./src/Application and running dotnet new ca-usecase. Here are some examples:

To create a new command:

dotnet new ca-usecase --name CreateTodoList --feature-name TodoLists --usecase-type command --return-type int

To create a query:

dotnet new ca-usecase -n GetTodos -fn TodoLists -ut query -rt TodosVm

To learn more, run the following command:

dotnet new ca-usecase --help

Database

The template supports PostgreSQL, SQLite, and SQL Server (default option). Specify the database to use with the --database option:

dotnet new ca-sln --database [postgresql|sqlite|sqlserver]

On application startup, the database is automatically deleted, recreated, and seeded using ApplicationDbContextInitialiser. This is a practical strategy for early development, avoiding the overhead of maintaining migrations while keeping the schema and sample data in sync with the domain model.

This process includes:

• Deleting the existing database
• Recreating the schema from the current model
• Seeding default roles, users, and data

For production environments, consider using EF Core migrations or migration bundles during deployment.
For more information, see Database Initialisation Strategies for EF Core.

Deploy

This template is structured to follow the Azure Developer CLI (azd). You can learn more about azd in the official documentation. To get started:

# Log in to Azure
azd auth login

# Provision and deploy to Azure
azd up

To set up a CI/CD pipeline (GitHub Actions or Azure DevOps):

azd pipeline config

API Documentation

This template includes built-in API documentation using ASP.NET Core OpenAPI and Scalar. Once the application is running, navigate to /scalar to explore the API using the Scalar UI.

The OpenAPI specification is generated at build time and written to wwwroot/openapi/v1.json.

Technologies

• ASP.NET Core 10
• Entity Framework Core 10
• Angular 21 or React 19
• MediatR
• AutoMapper
• FluentValidation
• NUnit, Shouldly, Moq & Respawn
• Scalar

Versions

The main branch is now on .NET 10.0. The following previous versions are available:

• 9.0
• 8.0
• 7.0
• 6.0
• 5.0
• 3.1

Learn More

• Clean Architecture with ASP.NET Core 3.0 (GOTO 2019)
• Clean Architecture with .NET Core: Getting Started

Support

If you are having problems, please let me know by raising a new issue.

License

This project is licensed with the MIT license.