isnakolah / cleanarchitectureapi

Clean Architecture API Application

This is the Clean Architecture API Application Template.

Technologies

• ASP.NET Core 5
• Entity Framework Core 5
• MediatR
• Automapper
• FluentValidation
• XUnit, FluentAssertions & Moq
• Docker

Getting Started

1. Install the latest .NET SDK
2. Run git clone https://github.com/isnakolah/clean-architecture-api.git CleanArchitectureAPI to clone the repo.
3. Navigate CleanArchitectureAPI/src/RESTApi to change directory into the project.
4. Run dotnet restore to load project Nuget packages.
5. Run dotnet run to run the project or dotnet watch run to auto compile the application.

Database Configuration

The application is configured to use an in-memory database by option. 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 RESTApi/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/Common/Infrastructure (optional if in this folder)
• --startup-project src/RESTApi
• --output-dir Persistence/Migrations

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

dotnet ef migrations add "InitialCommit" --project src\Common\Infrastructure --startup-project src\RESTApi --output-dir Persistence\Migrations

dotnet ef database update --project src\Common\Infrastructure --startup-project src\RESTApi

Moreover, on running the applications, the database updates automatically if the migration files change.

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.

RESTApi

This layer is a restful web api application based on ASP.NET 5.0.x. This layer depends on both the Application and Infrastructure layers, however, the dependency on Infrastructure is only to support dependency injection. Therefore only Startup.cs should reference Infrastructure.

Logs

Logging into Elasticsearch using Serilog and viewing logs in Kibana.

Prerequisites

• Download and Install Docker Desktop

Open CLI in the project folder and run the below comment.

PS EPharmacy> docker-compose up

If you are running first time Windows 10 WSL 2 (Windows Subsystem for Linux) Linux Container for Docker, You will probably get the following error from the docker.

Error: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

Solution: Open the Linux WSL 2 terminal sudo sysctl -w vm.max_map_count=262144 and change the virtual memory for Linux.

Support

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

License

This project is licensed with the MIT license.