Skip to content

Commit 9f25336

Browse files
committed
Update package version to 3.0.0, enhance documentation, and improve template instructions
1 parent 79174d3 commit 9f25336

File tree

5 files changed

+59
-20
lines changed

5 files changed

+59
-20
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
[license-url]: https://github.com/Genocs/microservice-template/blob/main/LICENSE
1818
[build-shield]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml/badge.svg?branch=main
1919
[build-url]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml
20-
[package-shield]: https://img.shields.io/badge/nuget-v.2.3.3-blue?&label=latests&logo=nuget
20+
[package-shield]: https://img.shields.io/badge/nuget-v.3.0.0-blue?&label=latests&logo=nuget
2121
[package-url]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml
2222
[downloads-shield]: https://img.shields.io/nuget/dt/Genocs.Microservice.Template.svg?color=2da44e&label=downloads&logo=nuget
2323
[downloads-url]: https://www.nuget.org/packages/Genocs.Microservice.Template
@@ -61,7 +61,7 @@
6161
</p>
6262
</p>
6363

64-
## Genocs .NET Web API Microservice Template
64+
# Genocs .NET Web API Microservice Template
6565

6666
Genocs .NET Web API Microservice Template is a starting point for your next `.NET9 Clean Architecture Project` that incorporates the most essential packages and features your projects will ever need including out of the box Multi-Tenancy support.
6767

@@ -110,6 +110,44 @@ The goal of this repository is to provide a complete and feature-rich starting p
110110
- :white_check_mark: MassTransit Integration
111111
- :white_check_mark: & Much More
112112

113+
## How to build and install the template locally
114+
115+
To build the package run the following commands:
116+
117+
[custom-templates](https://docs.microsoft.com/en-us/dotnet/core/tools/custom-templates)
118+
119+
[dotnet-templating](https://github.com/dotnet/templating)
120+
121+
```bash
122+
# To clone the repository
123+
git clone https://github.com/Genocs/microservice-template
124+
cd microservice-template
125+
126+
# To pack and install the template
127+
dotnet pack ./src/Package.Template.csproj -p:PackageVersion=3.0.0 --configuration Release --output ./out
128+
129+
dotnet new install ./out/Genocs.Microservice.Template.3.0.0.nupkg
130+
dotnet new gnx-microservice --help
131+
132+
# To uninstall the template
133+
dotnet new uninstall Genocs.Microservice.Template
134+
135+
# Example of creating a new project with full functionality
136+
dotnet new gnx-microservice --name {CompanyName.ServiceName} -gc full
137+
```
138+
139+
### Miscellaneous
140+
141+
Useful commands:
142+
143+
```bash
144+
# How to get the list of installed templates
145+
dotnet new -u
146+
147+
# How to get the list of templates
148+
dotnet new list
149+
```
150+
113151
## Documentation
114152

115153
Read Documentation related to this template here - [Template Documentation](https://genocs-blog.netlify.app/microservice-template/)

src/Package.Template.csproj

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,26 @@
33
<PropertyGroup>
44
<TargetFramework>net9.0</TargetFramework>
55
<PackageType>Template</PackageType>
6-
<PackageVersion>4.0.1</PackageVersion>
7-
<PackageId>Genocs.CleanArchitecture.Template</PackageId>
8-
<Title>Genocs - Clean Code Template</Title>
6+
<PackageVersion>3.0.0</PackageVersion>
7+
<PackageId>Genocs.Microservice.Template</PackageId>
8+
<Title>Genocs - Microservice Template</Title>
99
<Authors>Nocco Giovanni Emanuele</Authors>
10-
<Description>A .NET template following the Clean Architecture Style, DDD and Separation of Concerns in Domain, Application, Infrastructure and UI. Separated host for WebApi and ServiceBus. Docker compose debugging support provided as well.</Description>
11-
<PackageTags>aggregate;architecture;boilerplate;clean-architecture;clean-code;ddd;ddd-architecture;design-patterns;docker;domain-driven-design;dotnet;dotnetcore;dotnet-core;dotnet-cli;dotnet-new;dotnet-template;evolutionary-architecture;generator;hexagonal-architecture;layered;masstransit;microservice;microservices;nservicebus;onion;rabbitmq;service-bus;solid;solid-principles;templating;tdd;webapi</PackageTags>
12-
<PackageProjectUrl>https://github.com/Genocs/clean-architecture-template</PackageProjectUrl>
10+
<Description>Clean Architecture Template for .NET WebAPI built with Multitenancy Support.</Description>
11+
<PackageTags>cleanarchitecture;clean;architecture;webapi;solution;csharp</PackageTags>
12+
<PackageProjectUrl>https://github.com/Genocs/microservice-template</PackageProjectUrl>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1414
<PackageIcon>icon.png</PackageIcon>
1515
<PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
16-
<RepositoryUrl>https://github.com/Genocs/clean-architecture-template.git</RepositoryUrl>
16+
<RepositoryUrl>https://github.com/Genocs/microservice-template.git</RepositoryUrl>
1717
<RepositoryBranch>main</RepositoryBranch>
1818
<RepositoryType>git</RepositoryType>
1919
<Copyright>Copyright (c) 2025 Genocs Services</Copyright>
2020
<PackageReleaseNotes>
21-
Release notes:
22-
- Release 4.0.0:
23-
- Updated to .NET 9
24-
- Improved Docker support
25-
- Added new templates for CQRS and Event Sourcing
21+
Release 3.0.0:
22+
- Update nuget packages to latest versions.
23+
- Improved documentation.
24+
- Minor bug fixes and performance improvements.
25+
- Inserted instructions for GitHub Copilot and Cursor AI usage.
2626
</PackageReleaseNotes>
2727
<Language>en-US</Language>
2828
<IncludeBuildOutput>false</IncludeBuildOutput>

src/Package.Template.nuspec

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
33
<metadata minClientVersion="5.10.0">
44
<id>Genocs.Microservice.Template</id>
5-
<version>2.0.0</version>
5+
<version>3.0.0</version>
66
<title>Genocs - Microservice Template</title>
77
<authors>Nocco Giovanni Emanuele</authors>
88
<owners>[Genocs] Nocco Giovanni Emanuele</owners>
@@ -16,8 +16,11 @@
1616
<summary>.NET Microservice Template to implement solution based on Multitenancy.</summary>
1717
<description>Clean Architecture Template for .NET WebAPI built with Multitenancy Support.</description>
1818
<releaseNotes>
19-
Relesase 2.3.3:
20-
- Updated to .NET9
19+
Release 3.0.0:
20+
- Update nuget packages to latest versions.
21+
- Improved documentation.
22+
- Minor bug fixes and performance improvements.
23+
- Inserted instructions for GitHub Copilot and Cursor AI usage.
2124
</releaseNotes>
2225
<language>en-US</language>
2326
<packageTypes>

src/README_NUGET.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
[license-url]: https://github.com/Genocs/microservice-template/blob/main/LICENSE
1818
[build-shield]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml/badge.svg?branch=main
1919
[build-url]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml
20-
[package-shield]: https://img.shields.io/badge/nuget-v.2.3.3-blue?&label=latests&logo=nuget
20+
[package-shield]: https://img.shields.io/badge/nuget-v.3.0.0-blue?&label=latests&logo=nuget
2121
[package-url]: https://github.com/Genocs/microservice-template/actions/workflows/build_and_test.yml
2222
[downloads-shield]: https://img.shields.io/nuget/dt/Genocs.Microservice.Template.svg?color=2da44e&label=downloads&logo=nuget
2323
[downloads-url]: https://www.nuget.org/packages/Genocs.Microservice.Template

src/template/.template.config/template.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,7 @@
4444
"target": "./",
4545
"exclude": [
4646
".template.config/**",
47-
".idea/**",
4847
".vs/**",
49-
".github/**",
5048
"media/**"
5149
],
5250
"modifiers": [

0 commit comments

Comments
 (0)