Skip to content

Commit

Permalink
Updated packages -wip
Browse files Browse the repository at this point in the history
  • Loading branch information
giovanninocco committed Nov 17, 2023
1 parent 9452488 commit 486f076
Show file tree
Hide file tree
Showing 14 changed files with 82 additions and 60 deletions.
54 changes: 34 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,25 @@
[twitterx-url]: https://twitter.com/genocs


![.NET template banner](https://raw.githubusercontent.com/Genocs/microservice-template/main/assets/genocs-library-logo.png ".NET template banner")
<!-- PROJECT LOGO -->
<p align="center">
<a href="https://github.com/Genocs/microservice-template">
<img src="https://raw.githubusercontent.com/Genocs/microservice-template/main/assets/genocs-library-logo.png" alt=".NET Microservice Template">
</a>
<h3 align="center">.NET Microservice Template</h3>
<p align="center">
Open Source Solution Template For .NET7 Microservice
<br />
<a href="https://genocs-blog.netlify.app/microservice-template/general/getting-started/"><strong>Read the Documentation »</strong></a>
<br />
<br />
<a href="https://github.com/Genocs/microservice-template/issues">Report Bug</a>
·
<a href="https://github.com/Genocs/microservice-template/issues">Request Feature</a>
.
<a href="https://github.com/Genocs/microservice-template/issues">Request Documentation</a>
</p>
</p>

## Genocs .NET Web API Microservice Template

Expand All @@ -50,11 +68,7 @@ Genocs .NET Web API Microservice Template is a starting point for your next `.NE
> As the name suggests, this is an API / Server Template. You can find other Client Template that consume this API under `@genocs` handle.
> - Find `Blazor WebAssembly Template` here - [Blazor WebAssembly Template](https://github.com/Genocs/blazor-wasm-template)
The template can be used with the `genocs cli` or `dotnet new` command or with the `Visual Studio 2022` or `Visual Studio Code` IDEs.

## YouTube Video - Genocs Library - Getting Started

Watch the Getting started video here: [youtube intro](https://www.youtube.com/watch?v=TgxDvU---Ak)
The template can be used with the `genocs cli`, `dotnet new` command or with the `Visual Studio 2022`, `Visual Studio Code` IDEs.


## Goals
Expand Down Expand Up @@ -98,7 +112,7 @@ The goal of this repository is to provide a complete and feature-rich starting p

## Documentation

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

> Feel free to contribute to the Documentation Repository - [Contribute Documentation](https://github.com/Genocs/genocs-library-docs)
Expand All @@ -110,7 +124,7 @@ To get started with this Template, here are the available options:
- Install using the `dotnet new install` tool. Use this for any versions of the Template.
- Fork the Repository. Use this if you want to always keep your version of the Template up-to date with the latest changes.

> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://genocs-blog.netlify.app/dotnet-templates/general/development-environment/)
> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://genocs-blog.netlify.app/microservice-template/general/development-environment/)
### GENOCS CLI Tool

Expand Down Expand Up @@ -154,7 +168,7 @@ genocs api n CompanyName.ProjectName.ServiceName
```

This will create a new .NET7 Web API solution for you using the template.
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/dotnet-templates/)
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/microservice-template/)

#### Update

Expand All @@ -164,13 +178,14 @@ To update the tool & templates, run the following commands
dotnet tool update genocs.cli --global
genocs update
```

### Forking the Repository

You would probably need to take this approach if you want to keep your source code up to date with the latest changes. To get started based on this repository, you need to get a copy locally. You have three options: `fork, clone, or download`.

- Make a fork of this repository in your GitHub account.
- Create your new `dotnet-microservice-template` personal project by cloning the forked repository on your personal GitHub.
- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{githubuseraccount}/dotnet-microservice-template` and `git remote set-url --push upstream DISABLE`
- Create your new `microservice-template` personal project by cloning the forked repository on your personal GitHub.
- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{githubuseraccount}/microservice-template` and `git remote set-url --push upstream DISABLE`

For step by step instructions, follow: [this](https://discord.com/channels/878181478972928011/892573122186838046/933513103688224838) and [this](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274).

Expand All @@ -194,7 +209,7 @@ make start

That's it, the application would connect to the defined postgresql database and start creating tables, and seed required data.

For testing this API, we have 3 options.
For testing this API, we have 3 options:
1. Swagger @ `localhost:5001/swagger`
2. Postman collections are available `./postman`
3. ThunderClient for VSCode. You will have to install the Thunderclient extension for VSCode.
Expand Down Expand Up @@ -234,15 +249,15 @@ And here is the response.

```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjM0YTY4ZjQyLWE0ZDgtNDNlMy1hNzE3LTI1OTczZjZmZTJjNyIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6ImFkbWluQHJvb3QuY29tIiwiZnVsbE5hbWUiOiJyb290IEFkbWluIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InJvb3QiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zdXJuYW1lIjoiQWRtaW4iLCJpcEFkZHJlc3MiOiIxMjcuMC4wLjEiLCJ0ZW5hbnQiOiJyb290IiwiaW1hZ2VfdXJsIjoiIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbW9iaWxlcGhvbmUiOiIiLCJleHAiOjE2ODA5NDE3MzN9.VYNaNvk2T4YDvQ3wriXgk2W_Vy9zyEEhjveNauNAeJY",
"refreshToken": "pyxO30zJK8KelpEXF0vPfbSbjntdlbbnxrZAlUFXfyE=",
"token": "<your token>",
"refreshToken": "<your refresh token>",
"refreshTokenExpiryTime": "2023-04-15T07:15:33.5187598Z"
}
```

You will need to pass the `token` in the request headers to authenticate calls to the Genocs API!

For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/dotnet-templates)
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/microservice-template)

## Containerization

Expand Down Expand Up @@ -273,7 +288,7 @@ make dcu
make dcd
```

There are also examples for mysql & mssql variations. You can find the other docker-compose files under the ./docker-compose folder. Read more about docker-compose instructions & files here [docker-compose](./docker-compose/README.md).
There are also examples for mysql & mssql variations. You can find the other docker-compose files under the ./docker-compose folder. Read more about docker-compose instructions & files here [docker-compose](./docker-compose/README.md).

## Cloud Deployment with Terraform + AWS ECS

Expand Down Expand Up @@ -339,11 +354,11 @@ dotnet new gnx-microservice --name {{CompanyName.ProjectName.ServiceName}}

## Links & Documentations

[Overview](https://https://genocs-blog.netlify.app/dotnet-templates/general/overview/)
[Overview](https://https://genocs-blog.netlify.app/microservice-template/general/overview/)

[Getting Started](https://https://genocs-blog.netlify.app/dotnet-templates/general/getting-started/)
[Getting Started](https://https://genocs-blog.netlify.app/microservice-template/general/getting-started/)

[Development Environment](https://https://genocs-blog.netlify.app/dotnet-templates/general/development-environment/)
[Development Environment](https://https://genocs-blog.netlify.app/microservice-template/general/development-environment/)

[Participate in QNA & General Discussions](https://github.com/Genocs/microservice-template/discussions)

Expand Down Expand Up @@ -387,7 +402,6 @@ Become a financial contributor and help me sustain the project.

**Support the Project** on [Opencollective](https://opencollective.com/genocs)


## Acknowledgements

- [Mukesh Murugan](https://github.com/iammukeshm)
Expand Down
62 changes: 35 additions & 27 deletions README_NUGET.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,25 @@
[twitterx-url]: https://twitter.com/genocs


![.NET template banner](https://raw.githubusercontent.com/Genocs/microservice-template/main/assets/genocs-library-logo.png ".NET template banner")
<!-- PROJECT LOGO -->
<p align="center">
<a href="https://github.com/Genocs/microservice-template">
<img src="https://raw.githubusercontent.com/Genocs/microservice-template/main/assets/genocs-library-logo.png" alt=".NET Microservice Template">
</a>
<h3 align="center">.NET Microservice Template</h3>
<p align="center">
Open Source Solution Template For .NET7 Microservice
<br />
<a href="https://genocs-blog.netlify.app/microservice-template/general/getting-started/"><strong>Read the Documentation »</strong></a>
<br />
<br />
<a href="https://github.com/Genocs/microservice-template/issues">Report Bug</a>
·
<a href="https://github.com/Genocs/microservice-template/issues">Request Feature</a>
.
<a href="https://github.com/Genocs/microservice-template/issues">Request Documentation</a>
</p>
</p>

## Genocs .NET Web API Microservice Template

Expand All @@ -50,16 +68,12 @@ Genocs .NET Web API Microservice Template is a starting point for your next `.NE
> As the name suggests, this is an API / Server Template. You can find other Client Template that consume this API under `@genocs` handle.
> - Find `Blazor WebAssembly Template` here - [Blazor WebAssembly Template](https://github.com/Genocs/blazor-wasm-template)
The template can be used with the `genocs cli` or `dotnet new` command or with the `Visual Studio 2022` or `Visual Studio Code` IDEs.

## YouTube Video - Genocs Library - Getting Started

Watch the Getting started video here: [youtube intro](https://www.youtube.com/watch?v=TgxDvU---Ak)
The template can be used with the `genocs cli`, `dotnet new` command or with the `Visual Studio 2022`, `Visual Studio Code` IDEs.


## Goals

The goal of this repository is to provide a complete and feature-rich starting point for any .NET Developer / Team to kick-start their next major project using .NET7 Microservices architecture. This also serves the purpose of learning advanced concepts and implementations such as `Multitenancy, CQRS, Onion Architecture, Clean Coding standards, Docker Concepts, Cloud Deployments with Terraform to AWS, CI/CD Pipelines & Workflows` and so on.
The goal of this template is to provide a complete and feature-rich starting point for any .NET Developer / Team to kick-start their project using .NET7 Microservices architecture. This also serves the purpose of learning advanced concepts and implementations such as `Multitenancy, CQRS, Onion Architecture, Clean Coding standards, Docker Concepts, Cloud Deployments with Terraform to AWS, CI/CD Pipelines & Workflows` and so on.

## Features

Expand Down Expand Up @@ -98,7 +112,7 @@ The goal of this repository is to provide a complete and feature-rich starting p

## Documentation

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

> Feel free to contribute to the Documentation Repository - [Contribute Documentation](https://github.com/Genocs/genocs-library-docs)
Expand All @@ -110,7 +124,7 @@ To get started with this Template, here are the available options:
- Install using the `dotnet new install` tool. Use this for any versions of the Template.
- Fork the Repository. Use this if you want to always keep your version of the Template up-to date with the latest changes.

> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://genocs-blog.netlify.app/dotnet-templates/general/development-environment/)
> Make sure that your DEV enviroment is setup, [Read the Development Environment Guide](https://genocs-blog.netlify.app/microservice-template/general/development-environment/)
### GENOCS CLI Tool

Expand Down Expand Up @@ -154,7 +168,7 @@ genocs api n CompanyName.ProjectName.ServiceName
```

This will create a new .NET7 Web API solution for you using the template.
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/dotnet-templates/)
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/microservice-template/)

#### Update

Expand All @@ -164,13 +178,14 @@ To update the tool & templates, run the following commands
dotnet tool update genocs.cli --global
genocs update
```

### Forking the Repository

You would probably need to take this approach if you want to keep your source code up to date with the latest changes. To get started based on this repository, you need to get a copy locally. You have three options: `fork, clone, or download`.

- Make a fork of this repository in your GitHub account.
- Create your new `dotnet-microservice-template` personal project by cloning the forked repository on your personal GitHub.
- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{githubuseraccount}/dotnet-microservice-template` and `git remote set-url --push upstream DISABLE`
- Create your new `microservice-template` personal project by cloning the forked repository on your personal GitHub.
- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{githubuseraccount}/microservice-template` and `git remote set-url --push upstream DISABLE`

For step by step instructions, follow: [this](https://discord.com/channels/878181478972928011/892573122186838046/933513103688224838) and [this](https://gist.github.com/0xjac/85097472043b697ab57ba1b1c7530274).

Expand All @@ -194,7 +209,7 @@ make start

That's it, the application would connect to the defined postgresql database and start creating tables, and seed required data.

For testing this API, we have 3 options.
For testing this API, we have 3 options:
1. Swagger @ `localhost:5001/swagger`
2. Postman collections are available `./postman`
3. ThunderClient for VSCode. You will have to install the Thunderclient extension for VSCode.
Expand Down Expand Up @@ -234,15 +249,15 @@ And here is the response.

```json
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjM0YTY4ZjQyLWE0ZDgtNDNlMy1hNzE3LTI1OTczZjZmZTJjNyIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI6ImFkbWluQHJvb3QuY29tIiwiZnVsbE5hbWUiOiJyb290IEFkbWluIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InJvb3QiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zdXJuYW1lIjoiQWRtaW4iLCJpcEFkZHJlc3MiOiIxMjcuMC4wLjEiLCJ0ZW5hbnQiOiJyb290IiwiaW1hZ2VfdXJsIjoiIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbW9iaWxlcGhvbmUiOiIiLCJleHAiOjE2ODA5NDE3MzN9.VYNaNvk2T4YDvQ3wriXgk2W_Vy9zyEEhjveNauNAeJY",
"refreshToken": "pyxO30zJK8KelpEXF0vPfbSbjntdlbbnxrZAlUFXfyE=",
"token": "<your token>",
"refreshToken": "<your refresh token>",
"refreshTokenExpiryTime": "2023-04-15T07:15:33.5187598Z"
}
```

You will need to pass the `token` in the request headers to authenticate calls to the Genocs API!

For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/dotnet-templates)
For further steps and details, [Read the Getting Started Guide](https://genocs-blog.netlify.app/microservice-template)

## Containerization

Expand Down Expand Up @@ -273,7 +288,7 @@ make dcu
make dcd
```

There are also examples for mysql & mssql variations. You can find the other docker-compose files under the ./docker-compose folder. Read more about docker-compose instructions & files here [docker-compose](./docker-compose/README.md).
There are also examples for mysql & mssql variations. You can find the other docker-compose files under the ./docker-compose folder. Read more about docker-compose instructions & files here [docker-compose](./docker-compose/README.md).

## Cloud Deployment with Terraform + AWS ECS

Expand Down Expand Up @@ -325,11 +340,11 @@ make td

## Links & Documentations

[Overview](https://https://genocs-blog.netlify.app/dotnet-templates/general/overview/)
[Overview](https://https://genocs-blog.netlify.app/microservice-template/general/overview/)

[Getting Started](https://https://genocs-blog.netlify.app/dotnet-templates/general/getting-started/)
[Getting Started](https://https://genocs-blog.netlify.app/microservice-template/general/getting-started/)

[Development Environment](https://https://genocs-blog.netlify.app/dotnet-templates/general/development-environment/)
[Development Environment](https://https://genocs-blog.netlify.app/microservice-template/general/development-environment/)

[Participate in QNA & General Discussions](https://github.com/Genocs/microservice-template/discussions)

Expand Down Expand Up @@ -361,19 +376,12 @@ Here are a few ways by which you can support.

[![buy-me-a-coffee](https://raw.githubusercontent.com/Genocs/microservice-template/main/assets/buy-me-a-coffee.png "buy me a coffee")](https://www.buymeacoffee.com/genocs)

## Code Contributors

This project exists thanks to all the people who contribute. [Submit your PR and join the team!](CONTRIBUTING.md)

[![genocs contributors](https://contrib.rocks/image?repo=Genocs/microservice-template "genocs contributors")](https://github.com/Genocs/microservice-template/graphs/contributors)

## Financial Contributors

Become a financial contributor and help me sustain the project.

**Support the Project** on [Opencollective](https://opencollective.com/genocs)


## Acknowledgements

- [Mukesh Murugan](https://github.com/iammukeshm)
Expand Down
4 changes: 2 additions & 2 deletions src/template/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Roslynator.Analyzers" Version="4.6.0">
<PackageReference Include="Roslynator.Analyzers" Version="4.6.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435">
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.507">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
Expand Down
2 changes: 1 addition & 1 deletion src/template/src/Core/Application/Application.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<ProjectReference Include="..\Shared\Shared.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Update="Roslynator.Analyzers" Version="4.6.0">
<PackageReference Update="Roslynator.Analyzers" Version="4.6.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
Expand Down
2 changes: 1 addition & 1 deletion src/template/src/Core/Domain/Domain.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<ProjectReference Include="..\Shared\Shared.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Update="Roslynator.Analyzers" Version="4.6.0">
<PackageReference Update="Roslynator.Analyzers" Version="4.6.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
Expand Down
2 changes: 1 addition & 1 deletion src/template/src/Core/Shared/Shared.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Update="Roslynator.Analyzers" Version="4.6.0">
<PackageReference Update="Roslynator.Analyzers" Version="4.6.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
Expand Down

0 comments on commit 486f076

Please sign in to comment.