Gagibran.CleanArchRepo.Template 1.1.1

Clean Architecture Repository and Unit of Work Template

.NET template for creating projects using clean architecture with the repository pattern and optionally unit of work.

It uses PostgreSQL 14, React 18 (with TypeScript) and .NET 6 and it comes with a docker-compose file configured for development.

This app was developed using Docker version 20.10.16 and Docker Compose version 1.29.2.

Give it a star if you like it! Feel free to contribute.

Table of contents

• Motivation
• Installation
• Running And Options
• Running The Created Project
  • Development
• Adding Migrations
• To Do

Motivation

I created this template so that I don't have to write a lot of boilerplate code when I want to create a new project and I wanted to share my approach to this architecture.

This is heavily inspired in Steve 'Ardalis' Smith's clean architecture template. Check out his YouTube channel for more information on this architecture. I did not use the specification pattern here.

Installation

This package is hosted on NuGet and can be installed by simply running the command:

dotnet new --install Gagibran.CleanArchRepo.Template

Alternatively, download this repository and, in its root directory, run:

dotnet new --install .

Running And Options

Once installed, to use the template, simply run the command:

dotnet new cleanarchrepo -o <output-directory-name> -s <solution-name>

A project clean architecture project will be created with Swagger support and the unit of work pattern by default.

Note that the parameter -s, or --solutionName is a required parameter.

Alternatively, run the command without the -o parameter in order to create the template outside of a containing output directory.

In order to disabled these options, the following flags are available: -e or --enableSwagger and -c or --configureUnitOfWork. Example:

dotnet new cleanarchrepo -o <project-name> -e false -c false

Use dotnet new cleanarchrepo --help to see the list of parameters and more information.

Running The Created Project

The project is configured to run inside Docker containers.

Development

Once your project has been generated with the template, go the the project's root directory and execute the command:

docker-compose -f docker-compose-development.yml up

To start the application. The front end URL will be: http://localhost:3000. If you enabled Swagger during the template creation, you can access it going to the following URL: http://localhost:5000/swagger.

It comes with a default User entity so that you can test the CRUD operations right out of the box by either using Swagger or an API platform, such as Postman.

You can also do CRUD operations using the UI (React). There is only one user component added to represent how the front end communicates with the back end. There are no custom CSS styles.

To terminate the application and delete the created images, containers, networks and volumes, hit Ctrl+C on your running terminal to stop the application, go the the project's root directory and run:

docker-compose -f docker-compose-development.yml down -v

Adding Migrations

To add a migration, go to the project's root directory and run:

dotnet ef migrations add <migration-name> -p .\src\Infrastructure\ -s .\src\API\ -o .\Data\Migrations\

No need to install the dotnet-ef tool, because it is already in the .\.config\dotnet-tools.json manifest file.

To Do

• Currently, the project does not contain a unit tests project. This will be added soon.
• I will also add Angular support and an option to configure different databases.
• I will try to get the project to work with HTTPS on Docker.
• Finally, I will be adding a production configuration with Dockerfiles and a production Docker Compose file.