CaseTunisia.Tools.BackgroundTaskRunner 1.3.0

Technologies

• ASP.NET Core 6
• Entity Framework Core 6.0.5
• Angular 10
• MediatR
• AutoMapper
• FluentValidation
• NUnit, FluentAssertions, Moq & Respawn
• Docker

Getting Project and submodule

To get the projecy and its submodule:

  git clone --recurse-submodules git@git.case-tunisia.com:Bosch/pad-qmm.git

To get and init the submodule also to update them allways use this one is prefered so you get the new modules when they are added:

  git submodule update --init --recursive

To update the submodule to the last version:

  git submodule update --remote

Getting Started

In order to get start the application make sure to verify your settings in src/WebUI/appsettings.json especialy the connection string

1. Navigate to src/WebUI/ClientApp and run npm install
2. Navigate to src/WebUI/ClientApp and run npm start to launch the front end (Angular)
3. Navigate to src/WebUI and run dotnet run to launch the back end (ASP.NET Core Web API)

Testing The API

After runing the project (flow Getting Started topic), the very first thing you need to do in to login to obtain an access token, which can be found in your browser devtools and then navigate to the (storage / Application tab / or what ever) where you can find the session storage select your app url and copy the access_token value.

Second step is to navigate to the api url or click the api navigation in the top Nav menu. click on the authorize button and then Type into the textbox: Bearer

Now you can test the api's commands and queries.

Docker Configuration

In order to get Docker working, you will need to add a temporary SSL cert and mount a volume to hold that cert. You can find Microsoft Docs that describe the steps required for Windows, macOS, and Linux.

For Windows: The following will need to be executed from your terminal to create a cert dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\aspnetapp.pfx -p @Case123 dotnet dev-certs https --trust

NOTE: When using PowerShell, replace %USERPROFILE% with $env:USERPROFILE.

FOR macOS: dotnet dev-certs https -ep ${HOME}/.aspnet/https/aspnetapp.pfx -p @Case123 dotnet dev-certs https --trust

FOR Linux: dotnet dev-certs https -ep ${HOME}/.aspnet/https/aspnetapp.pfx -p @Case123

In order to build and run the docker containers, execute docker-compose -f 'docker-compose.yml' up --build from the root of the solution where you find the docker-compose.yml file. You can also use "Docker Compose" from Visual Studio for Debugging purposes. Then open http://localhost:5000 on your browser.

Database Configuration

The template 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 WebUI/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/WebUI
• --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\WebUI --output-dir Persistence\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.

WebUI

This layer is a single page application based on Angular 10 and ASP.NET Core 5. 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.

Support

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