netcore-boilerplate

Boilerplate of API in .NET Core 3.1 .NET 7

GitHub	Codecov

Boilerplate is a piece of code that helps you to quickly kick-off a project or start writing your source code. It is kind of a template - instead of starting an empty project and adding the same snippets each time, you can use the boilerplate that already contains such code.

Source code contains

1. Central Package Management (CPM)
2. [Autofac](https://autofac.org/) (Removed in PR19)
3. Swagger + Swashbuckle
4. FeatureManagement (Feature Flags, Feature Toggles)
5. HealthChecks
6. EF Core
   • MySQL provider from Pomelo Foundation
   • MsSQL from Microsoft
7. Tests
   • Integration tests with InMemory database
     • FluentAssertions
     • xUnit
     • Verify
     • TestServer
   • Unit tests
     • AutoFixture
     • FluentAssertions
     • Moq
     • Moq.AutoMock
     • xUnit
   • Architectural tests (conventional tests)
     • NetArchTest
     • xUnit
   • Load tests (Removed in PR135)
     • [NBomber](https://nbomber.com/)
8. Code quality
   • EditorConfig (.editorconfig)
   • Analizers
     • Microsoft.CodeAnalysis.Analyzers
     • Microsoft.AspNetCore.Mvc.Api.Analyzers
     • Microsoft.VisualStudio.Threading.Analyzers
   • CodeAnalysisRules HappyCode.NetCoreBoilerplate.ruleset
   • Code coverage
     • Coverlet
     • Codecov
   • CI Code analysis with CodeQL
9. Docker
   • Dockerfile
   • Docker-compose
     • mysql:8 with DB initialization
     • mcr.microsoft.com/mssql/server:2017-latest with DB initialization
     • netcore-boilerplate:local
10. Serilog
    • Sink: Async
11. DbUp as a db migration tool
12. Continuous integration
    • [Travis CI](https://travis-ci.org/) (travisci.yml)
    • GitHub Actions
      • dotnetcore.yml
      • codeql-analysis.yml
      • docker.yml

Architecture

Api

HappyCode.NetCoreBoilerplate.Api

• The entry point of the app - Program.cs
• Simple Startup class - Startup.cs
  • MvcCore
  • DbContext (with MySQL)
  • DbContext (with MsSQL)
  • Swagger and SwaggerUI (Swashbuckle)
  • HostedService and HttpClient
  • FeatureManagement
  • HealthChecks
    • MySQL
    • MsSQL
• Filters
  • Simple ApiKey Authorization filter - ApiKeyAuthorizationFilter.cs
  • Action filter to validate ModelState - ValidateModelStateFilter.cs
  • Global exception filter - HttpGlobalExceptionFilter.cs
• Configurations
  • Serilog configuration place - SerilogConfigurator.cs
  • Swagger registration place - SwaggerRegistration.cs
• Simple exemplary API controllers - EmployeesController.cs, CarsController.cs
• Example of BackgroundService - PingWebsiteBackgroundService.cs

Core

HappyCode.NetCoreBoilerplate.Core

• Models
  • Dto models
  • DB models
  • AppSettings models - Settings
• DbContexts
  • MySQL DbContext - EmployeesContext.cs
  • MsSQL DbContext - CarsContext.cs
• Core registrations - CoreRegistrations.cs
• Exemplary MySQL repository - EmployeeRepository.cs
• Exemplary MsSQL service - CarService.cs

DB Migrations

HappyCode.NetCoreBoilerplate.Db

• Console application as a simple db migration tool - Program.cs
• Sample migration scripts, both .sql and .cs - S001_AddCarTypesTable.sql, S002_ModifySomeRows.cs

Tests

Integration tests

HappyCode.NetCoreBoilerplate.Api.IntegrationTests

• Infrastructure
  • Fixture with TestServer - TestServerClientFixture.cs
  • TestStartup with InMemory databases - TestStartup.cs
  • Simple data feeders - EmployeeContextDataFeeder.cs, CarsContextDataFeeder.cs
• Exemplary tests - EmployeesTests.cs, CarsTests.cs

Unit tests

HappyCode.NetCoreBoilerplate.Api.UnitTests

• Exemplary tests - EmployeesControllerTests.cs
• Unit tests of ApiKeyAuthorizationFilter.cs - ApiKeyAuthorizationFilterTests.cs

HappyCode.NetCoreBoilerplate.Core.UnitTests

• Extension methods to mock DbSet faster - EnumerableExtensions.cs
• Exemplary tests - EmployeeRepositoryTests.cs, CarServiceTests.cs

Architectural tests

HappyCode.NetCoreBoilerplate.ArchitecturalTests

• Exemplary tests - ApiArchitecturalTests.cs, CoreArchitecturalTests.cs

How to adapt to your project

Generally it is totally up to you! But in case you do not have any plan, You can follow below simple steps:

1. Download/clone/fork repository ⤵️
2. Remove components and/or classes that you do not need to 🔥
3. Rename files (e.g. sln, csproj, ruleset), folders, namespaces etc 📝
4. Appreciate the work ⭐

Build the solution

Just execute dotnet build in the root directory, it takes HappyCode.NetCoreBoilerplate.sln and build everything.

Start the application

Standalone

At first, you need to have up and running MySQL and MsSQL database servers on localhost with initialized database by mysql script and mssql script.

Then the application (API) can be started by dotnet run command executed in the src/HappyCode.NetCoreBoilerplate.Api directory. By default it will be available under http://localhost:5000/, but keep in mind that documentation is available under http://localhost:5000/swagger/.

Docker (recommended)

Just run docker-compose up command in the root directory and after successful start of services visit http://localhost:5000/swagger/. To check that API has connection to both MySQL and MsSQL databases visit http://localhost:5000/health/.

When running on Linux (i.e. WSL), make sure that all docker files (dockerfile, docker-compose and all mssql files) have line endings LF.

Migrations

When the entire environment is up and running, you can additionally run a migration tool to add some new schema objects into MsSQL DB. To do that, go to src/HappyCode.NetCoreBoilerplate.Db directory and execute dotnet run command.

Run unit tests

Run dotnet test command in the root directory, it will look for test projects in HappyCode.NetCoreBoilerplate.sln and run them.

To Do

• any idea? Please create an issue.

Be like a star, give me a star! ⭐

If:

• you like this repo/code,
• you learn something,
• you are using it in your project/application,

then please give me a star, appreciate my work. Thanks!

Buy me a coffee! ☕