This repository contains a practical example about how to pack multiple dotnet templates in a single NuGet package and use it within Visual Studio or the .NET CLI.
To work with these templates you need Visual Studio version 16.10 or higher.
Each template contains a series of preprocessor directives and placeholder values, so don't try to clone the repository and use the templates directly because it won't work. You need to install the templates via .NET CLI and then use it with the .NET CLI or within Visual Studio.
If you want to install this templates there are 3 options available:
1- There is a powershell script in the root level of this repository create-nuget.ps1. If you try execute the script, it will create a .nupkg file on your filesystem. Afterward, you can install the .nupkg using the dotnet new -i MyTechRamblings.Templates.0.3.0.nupkg command.
2 - Run the dotnet new -i MyTechRamblings.Templates::0.3.0 command. This command will try to fetch the package from nuget.org and install it.
3 - Download the package from nuget.org and install it using the the dotnet new -i MyTechRamblings.Templates.0.3.0.nupkg command.
After installing the templates pack you should run the dotnet new -l command and verify that the 3 templates appear on the list (mtr-api, mtr-rabbit-worker, mtr-az-func-timer).
This repository is tied to the post series "How to build a .NET template and use it within Visual Studio" from my blog. You can read it here
Right now there are only 3 templates. More incoming in a near future.
- It is an entire solution application. It uses a N-layer architecture with 3 layers:
WebApilayer.Librarylayer.Repositorylayer.
- It uses the
Microsoft.Build.CentralPackageVersionsMSBuild SDK. This SDK allows us to manage all the NuGet package versions in a single file. The file can be found in the/buildfolder. - The api has the following features already built-in:
HealthChecksSwaggerSerilogAutoMapperMicrosoft.Identity.WebDockerfile
- It includes an
Azure PipelinesYAML file and aGitHub ActionYAML file that deploys the app into an Azure App Service.
When you create a new solution using the template via Visual Studio or the .NET CLI you will be asked to specify the following parameters.
Each parameter has a default value, so you can ran with the defaults if you like.
| Parameter Name | Description | Default value |
|---|---|---|
| Docker | Adds an optimised Dockerfile to add the ability to build a Docker image. | true |
| ReadMe | Adds a README markdown file describing the project. | true |
| Tests | Adds an integration test project and a unit test project in the solution. | true |
| GitHub | Adds a GitHub Action file into the solution that deploys the api into an Azure Web App. | false |
| AzurePipelines | Adds an Azure pipeline YAML file into the solution that deploys the api into an Azure Web App. | true |
| DeploymentType | Specifies how you want to deploy the api. The possible values are DeployAsZip or DeployAsContainer. Depending of the value you choose the content of the deployment pipeline will vary. If you choose to not create neither a GitHub Action nor an Azure Pipeline this parameter is useless. |
DeployAsZip |
| AcrName | An Azure ACR registry name. Only used if you are going to be deploying with container. | acrcponsndev |
| AzureSubscriptionName | An Azure DevOps Service Endpoint subscription. Only used if you are going to be deploying with Azure Pipelines. | cponsn-dev-subscription |
| AppServiceName | The name of the Azure App Service where the code will be deployed. | app-svc-demo-dev |
| Authorization | Enables or disables the use of authorization using Microsoft.Identity.Web |
true |
| AzureAdTenantId | Azure Active Directory Tenant Id. Only necessary if Authorization is enabled. | 8a0671e2-3a30-4d30-9cb9-ad709b9c744a |
| AzureAdDomain | Azure Active Directory Domain Name. Only necessary if Authorization is enabled. | cpnoutlook.onmicrosoft.com |
| AzureAdClientId | Azure Active Directory App Client Id. Only necessary if Authorization is enabled. | fdada45d-8827-466f-82a5-179724a3c268 |
| AzureAdSecret | Azure Active Directory App Secret Value. Only necessary if Authorization is enabled. | 1234 |
| HealthCheck | Enables or disables the use of healthchecks. | true |
| HealthCheckPath | HealthCheck path. Only necessary if HealthCheck is enabled. | /health |
| Swagger | Enables or disables the use of Swagger. | true |
| SwaggerPath | Swagger path. Do not add a backslash. Only necessary if Swagger is enabled. | api-docs |
| Contact | The contact details to use if someone wants to contact you. Only necessary if Swagger is enabled. | [email protected] |
| CompanyName | The name of the company. Only necessary if Swagger is enabled. | mytechramblings |
| CompanyWebsite | The website of the comany. Needs to be a valid URI. Only necessary if Swagger is enabled. | https://www.mytechramblings.com |
| ApiDescription | The description of the api. Only necessary if Swagger is enabled. | Put your api info here. |
- It is an entire solution application.
- The application is a
BackgroundServicethat consumes messages from a RabbitMq server. It uses a N-layer architecture with 3 layers:Workerlayer.Librarylayer.Repositorylayer.
- It uses the
Microsoft.Build.CentralPackageVersionsMSBuild SDK. This SDK allows us to manage all the NuGet package versions in a single file. The file can be found in the/buildfolder. - The service has the following features already built-in:
SerilogAutoMapperMicrosoft.Extensions.Hosting.SystemdMicrosoft.Extensions.Hosting.WindowsServicesDockerfile
- It includes an
Azure PipelinesYAML file and aGitHub ActionYAML file that deploys the app into an Azure App Service.
When you create a new solution using the template via Visual Studio or the .NET CLI you will be asked to specify the following parameters.
Each parameter has a default value, so you can either ran with the defaults or you can tailor the template to your own needs.
| Parameter Name | Description | Default value |
|---|---|---|
| Docker | Adds an optimised Dockerfile to add the ability to build a Docker image. | true |
| ReadMe | Adds a README markdown file describing the project. | true |
| Tests | Adds an integration test project and a unit test project in the solution. | true |
| GitHub | Adds a GitHub Action file into the solution that deploys the service into an Azure Web App. | false |
| AzurePipelines | Adds an Azure pipeline YAML file into the solution that deploys the service into an Azure Web App. | true |
| DeploymentType | Specifies how you want to deploy the api. The possible values are DeployAsZip or DeployAsContainer. Depending of the value you choose the content of the deployment pipeline will vary. If you choose to not create neither a GitHub Action nor an Azure Pipeline this parameter is useless. |
DeployAsZip |
| AcrName | An Azure ACR registry name. Only used if you are going to be deploying with container. | acrcponsndev |
| AzureSubscriptionName | An Azure DevOps Service Endpoint subscription. Only used if you are going to be deploying with Azure Pipelines. | cponsn-dev-subscription |
| AppServiceName | The name of the Azure App Service where the code will be deployed. | app-svc-demo-dev |
| QueueName | The name of the RabbitMq queue where the consumer is going to be attached. | Queue1 |
| RabbitMqUsername | A RabbitMq user name used to connect to the server. | demo |
| RabbitMqPassword | A RabbitMq user password used to connect to the server. | 1234 |
| RabbitMqServer | The RabbitMq server uri. | 127.0.0.1 |
| RabbitMqPort | A RabbitMq server port used to connect to the server. | 5672 |
- This one is not an entire solution, instead it is just a single project.
- It is a NET Core 3.1 Azure Function that is triggered by a timer.
- The function has the following features already built-in:
Dependency InjectionLogging
- It includes an
Azure PipelinesYAML file and aGitHub ActionYAML file that deploys the app into an Azure App Service.
QUICK TIP
If you want to test your Azure Function running with your local docker machine use this command:docker run -d -e AzureWebJobsStorage="UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://host.docker.internal" <IMAGE_NAME>
When you create a new solution using the template via Visual Studio or the .NET CLI you will be asked to specify the following parameters.
Each parameter has a default value, so you can either ran with the defaults or you can tailor the template to your own needs.
| Parameter Name | Description | Default value |
|---|---|---|
| Docker | Adds an optimised Dockerfile to add the ability to build a Docker image. | true |
| GitHub | Adds a GitHub Action file into the project that deploys the function into Azure Functions. | false |
| AzurePipelines | Adds an Azure pipeline YAML file into the project that deploys the function into Azure Functions. | true |
| DeploymentType | Specifies how you want to deploy the api. The possible values are DeployAsZip or DeployAsContainer. Depending of the value you choose the content of the deployment pipeline will vary. If you choose to not create neither a GitHub Action nor an Azure Pipeline this parameter is useless. |
DeployAsZip |
| AcrName | An Azure ACR registry name. Only used if you are going to be deploying with container. | acrcponsndev |
| AzureSubscriptionName | An Azure DevOps Service Endpoint subscription. Only used if you are going to be deploying with Azure Pipelines. | cponsn-dev-subscription |
| FunctionName | The name of the Azure Function where the code will be deployed. | MyFunction |
| Cron | The timer trigger expression. Needs to be a Cron expression. | 0 * * * * * |
| LogLevel | Default Log Level for the Azure Function. | Information |