MainProject
Table of contents
What is BasicDotnetTemplate?
BasicDotnetTemplate is a basic project written in .NET 8. It contains MainProject, a WebApi project, and MainProject.Tests written in .NET 8 that contains tests for MainProject.
Technologies
Dotnet
Every component is developed using dotnet-core 8.0.201 and was generated with dotnet.
.NET is the free, open-source, cross-platform framework for building modern apps and powerful cloud services. Supported on Windows, Linux, and macOS.
Commands
Debug
You can use the following comands in the MainProject folder.
dotnet watch run
Restarts or hot reloads the specified application, or runs a specified dotnet command, when changes in source code are detected.
Entity Framework
This project uses Entity Framework Core, you can find the official documentation here.
Entity Framework is an Object/Relational Mapping (O/RM) framework. It is an enhancement to ADO.NET that gives developers an automated mechanism for accessing & storing the data in the database. EF Core supports two development approaches 1) Code-First 2) Database-First. In the code-first approach, EF Core API creates the database and tables using migration based on the conventions and configuration provided in your domain classes. This approach is useful in Domain Driven Design (DDD).
Sonarcloud
This project is scanned on SonarCloud, a powerful cloud-based code analysis service designed to detect coding issues. It works with GitHub, Bitbucket Cloud, Azure DevOps and GitLab. You can find the integration in build.yml.
Quality gate
A Quality Gate is a set of measure-based, Boolean conditions. It helps you know immediately whether your projects are production-ready. This project uses Sonar way quality gate:
| Condition | Metric and rating | Real rating |
|---|---|---|
| No new bugs are introduced | Reliability rating is A | |
| No new vulnerabilities are introduced | Security rating is A | |
| New code has limited technical debt | Maintainability rating is A | |
| All new security hotspots are reviewed | ||
| New code is sufficiently covered by test | Coverage is greater than or equal to 80.0% | |
| New code has limited duplication | Duplicated Lines (%) is less than or equal to 3.0% |
Code smells
One way to look at smells is with respect to principles and quality: "Smells are certain structures in the code that indicate violation of fundamental design principles and negatively impact design quality".[Suryanarayana, Girish (November 2014). Refactoring for Software Design Smells. Morgan Kaufmann.] Code smells are usually not bugs; they are not technically incorrect and do not prevent the program from functioning. Instead, they indicate weaknesses in design that may slow down development or increase the risk of bugs or failures in the future. Bad code smells can be an indicator of factors that contribute to technical debt.[Tufano, Michele; Palomba, Fabio; Bavota, Gabriele; Oliveto, Rocco; Di Penta, Massimiliano; De Lucia, Andrea; Poshyvanyk, Denys (2015).] Robert C. Martin calls a list of code smells a "value system" for software craftsmanship.[Martin, Robert C. (2009). "17: Smells and Heuristics". Clean Code: A Handbook of Agile Software Craftsmanship. Prentice Hall.]