Skip to content

Latest commit

 

History

History
132 lines (93 loc) · 5.83 KB

README.md

File metadata and controls

132 lines (93 loc) · 5.83 KB
Raw

Clean Architecture Solution Template

Build CodeQL Nuget Nuget Twitter Follow

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 9.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::9.0.8

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 templates supports PostgresSQL, SQLite, and SQL Server (default option). Specify the database to use with the --database option:

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

When you run the application the database will be automatically created (if necessary) and the latest migrations will be applied.

Running database migrations is easy. Ensure you add the following flags to your command (values assume you are executing from repository root)

  • --project src/Infrastructure (optional if in this folder)
  • --startup-project src/Web
  • --output-dir Data/Migrations

For example, to add a new migration from the root folder:

dotnet ef migrations add "SampleMigration" --project src\Infrastructure --startup-project src\Web --output-dir Data\Migrations

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

# Provsion and deploy to Azure
azd up

Technologies

Versions

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

Learn More

Support

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

License

This project is licensed with the MIT license.