Starting up a new web-api -project with dotnet I find myself repeating a lot of the same things.
This is a repository with the basic setup:
- devcontainer to develop c# 7 with a postgres database
- a sln -file (proj.sln, should be renamed when using this as a template)
- a web-api project (src/Backend, could be renamed when using this as a template)
- a test project (test/Backend.Tests, could be renamed when using this as a template)
- basic setup for creating and using the database in Backend through Dapper
- basic tests for the Backend using the api exercising:
- OpenApi (/swagger)
- healthcheck (/healthz and /readyz)
- version (/version)
GPLv3 - see LICENSE file. This is a template repository, if the license does not work for you - talk to me or create your own repository from scratch.
cd src/Backend
dotnet publish --os linux --arch x64 -p:PublishProfile=DefaultContainer -c ReleaseNerdBank.GitVersioning has been added to the project. This means that the version is automatically updated based on the git history. Control the main numbers of the version in the file version.json, in the root of the repository. The file Directory.Build.props tells msbuild to use NerdBank.GitVersioning to set the version of the project.
To dive deeper - see the versioning documentation.
Running the devcontainer will set up an Otel -collector, Prometheus and Jaeger. With these you can monitor what happens in the application. You will find Prometheus at http://localhost:9090 and Jaeger at http://localhost:16686.
Tasks have been set up to run tests and the application. With the task watch run Backend you will have a running application that you can connect the debugger to, and the task watch test Backend.Tests will run the tests for the Backend and watch for changes. Any failing tests will show up in the Problems tab.
-
DockerfileSet up docker publish for the Backend - Github action
- OpenTelemetry setup
- Documentation -templates
- Architectural decision records -templates