Need help with netcore-boilerplate?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

lkurzyniec
206 Stars 58 Forks GNU General Public License v2.0 93 Commits 1 Opened issues

Description

Boilerplate of API in .NET Core 3.1

Services available

!
?

Need anything else?

Contributors list

netcore-boilerplate

Boilerplate of API in

.NET Core 3.1

| GitHub | Codecov | |:-------------:|:-------------:| | GitHub Build Status | 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. ~~[Autofac]~~(https://autofac.org/) (Removed in PR19)
  2. Swagger + Swashbuckle
  3. FeatureManagement (Feature Flags, Feature Toggles)
  4. HealthChecks
  5. EF Core
  6. Tests
  7. Code quality
  8. Docker
    • Dockerfile
    • Docker-compose
      • mysql:8
        with DB initialization
      • mcr.microsoft.com/mssql/server:2017-latest
        with DB initialization
      • netcore-boilerplate:local
  9. Serilog
  10. DbUp as a db migration tool
  11. Continuous integration

Architecture

Api

HappyCode.NetCoreBoilerplate.Api

HappyCode.NetCoreBoilerplate.Api

Core

HappyCode.NetCoreBoilerplate.Core

HappyCode.NetCoreBoilerplate.Core

DB Migrations

HappyCode.NetCoreBoilerplate.Db

HappyCode.NetCoreBoilerplate.Db

Tests

Integration tests

HappyCode.NetCoreBoilerplate.Api.IntegrationTests

HappyCode.NetCoreBoilerplate.Api.IntegrationTests

Unit tests

HappyCode.NetCoreBoilerplate.Api.UnitTests

HappyCode.NetCoreBoilerplate.Core.UnitTests

HappyCode.NetCoreBoilerplate.Core.UnitTests

Load tests

Keep in mind that entire environment has to be up and running.

HappyCode.NetCoreBoilerplate.Api.LoadTests

HappyCode.NetCoreBoilerplate.Api.LoadTests

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 :arrowheadingdown:
  2. Remove components and/or classes that you do not need to :fire:
  3. Rename files (e.g. sln, csproj, ruleset), folders, namespaces etc :memo:
  4. Appreciate the work :star:

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/.

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.

Migrate from ASP .NET Core 2.2 to 3.1

Need to migrate from

.NET Core 2.2
to
.NET Core 3.1
? There's an Microsoft article about this, but you can also, just in case, take a look at my migration commit where you can find the complete list of required changes.

To Do

  • any idea? Please create an issue.

Be like a star, give me a star! :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! :coffee:

Buy me a coffee

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.