dpoblacion / cleanarchitecture

Clean Architecture Solution Template for .NET 6

Clean Architecture Solution

This is a solution following the principles of Clean Architecture.

Technologies

• ASP.NET Core 6
• Entity Framework Core 6
• React
• MediatR
• AutoMapper
• FluentValidation
• Serilog
• xUnit
• FluentAssertions
• Moq

Getting Started

1. Install the latest .NET 6 SDK
2. Install the latest Node.js LTS
3. Navigate to src/WebUI/ClientApp and run npm install
4. Navigate to src/WebUI/ClientApp and run npm start to launch the front end (Angular)
5. Navigate to src/WebUI and run dotnet run to launch the back end (ASP.NET Core Web API)

Database Configuration

The solution is configured to use an in-memory database by default. This ensures that all users will be able to run the solution without needing to set up additional infrastructure (e.g. SQL Server).

If you would like to use SQL Server, you will need to update Web/appsettings.json as follows:

  "UseInMemoryDatabase": false,

Verify that the DefaultConnection connection string within appsettings.json points to a valid SQL Server instance.

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

Database Migrations

To use dotnet-ef for your migrations please 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 Persistence/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 Persistence\EntityFramework\Migrations

Overview

Domain

This will contain all entities, enums, exceptions, interfaces, types and logic specific to the domain layer.

Application

This layer contains all application logic. It is dependent on the domain layer, but has no dependencies on any other layer or project. This layer defines interfaces that are implemented by outside layers. For example, if the application need to access a notification service, a new interface would be added to application and an implementation would be created within infrastructure.

Infrastructure

This layer contains classes for accessing external resources such as file systems, web services, smtp, and so on. These classes should be based on interfaces defined within the application layer.

Web

This layer is a single page application based on React and ASP.NET Core 6. This layer depends on both the Application and Infrastructure layers, however, the dependency on Infrastructure is only to support dependency injection. Therefore only Program.cs should reference Infrastructure.