Skip to content

Commit f892d4d

Browse files
committed
chore: Update CLI documentation with new commands and last modified dates, and add acknowledgements section in layout
1 parent 4f9addd commit f892d4d

File tree

2 files changed

+70
-20
lines changed

2 files changed

+70
-20
lines changed

content/en/cli/index.md

Lines changed: 60 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "CLI"
33
description: "The genocs CLI (Command Line Interface) tool is a powerful and versatile command-line utility that enables developers to efficiently build, test, and run applications. It provides unified experience across different platforms, allowing developers to create cross-platform applications with ease. With its extensive set of commands, the .NET CLI tool simplifies the development process by automating tasks such as project management, dependency resolution, and deployment. It is an essential tool for modern developers, offering productivity, flexibility, and scalability in application development."
44
date: 2023-05-13T15:40:19+02:00
5-
lastmod: 2024-11-16T00:00:00+02:00
5+
lastmod: 2024-12-01T00:00:00+02:00
66
draft: false
77
images: []
88
---
@@ -70,15 +70,16 @@ The picture shows the console log upon the template is installed.
7070

7171
## The Templates
7272

73-
| Template | Command | To be used for |
74-
|:----------------|:------------------|------------------------------------------------:|
75-
| angular | gnx-angular | angular front-end SPA |
76-
| react | gnx-react | react front-end SPA |
77-
| blazor | gnx-wasmblazor | web assembly - blazor portal |
78-
| cleanblazor | gnx-cleanblazor | clean architecture - blazor portal |
79-
| webapi | gnx-cleanwebapi | onion clean architecture - WebAPI |
80-
| webapi | gnx-microwebapi | microservice multitenant - WebAPI |
81-
| webapi | gnx-librawebapi | microservice on top of Genocs Library - WebAPI |
73+
| Template | Command | CLI Command | To be used for |
74+
|:----------------|:------------------|:----------------------|------------------------------------------------:|
75+
| angular | gnx-angular | **angular** | angular front-end SPA |
76+
| react | gnx-react | **react** | react front-end SPA |
77+
| blazor | gnx-wasmblazor | **blazor-wasm** | web assembly - blazor portal |
78+
| cleanblazor | gnx-cleanblazor | **blazor-clean** | clean architecture - blazor portal |
79+
| webapi | gnx-cleanwebapi | **clean-webapi** | onion clean architecture - WebAPI |
80+
| webapi | gnx-microwebapi | **micro-webapi** | microservice multitenant - WebAPI |
81+
| webapi | gnx-librawebapi | **libra-webapi** | microservice on top of Genocs Library - WebAPI |
82+
8283

8384
## Uninstall templates
8485

@@ -102,23 +103,23 @@ To create a blazor portal use one of these commands
102103

103104
``` bash
104105
# To build a blazor portal
105-
genocs blazor new <Company.Project.Service>
106+
genocs blazor-wasm new <Company.Project.Service>
106107

107-
# (SOON) To build a clean architecture blazor portal
108-
genocs cleanblazor new <Company.Project.Service>
108+
# To build a clean architecture blazor portal
109+
genocs blazor-clean new <Company.Project.Service>
109110
```
110111

111112
### WebAPI
112113

113114
``` bash
114115
# To build a web api architecture webapi
115-
genocs webapi new <Company.Project.Service>
116+
genocs libra-webapi new <Company.Project.Service>
116117

117-
# Another option to build a clen architecture webapi
118-
genocs cleanapi new <Company.Project.Service>
118+
# Another option to build a clean architecture webapi
119+
genocs clean-webapi new <Company.Project.Service>
119120

120121
# To build a microservice web Api with multitenant support
121-
genocs microservice <Company.Project.Service>
122+
genocs micro-webapi <Company.Project.Service>
122123
```
123124

124125
## The solution
@@ -138,13 +139,52 @@ dotnet build ./src/genocs.cli.csproj
138139
# Pack the tool (to be deployed on nuget)
139140
dotnet pack
140141

141-
# Run the tool to install the templates using the net8 as runtime
142-
dotnet run -f net8.0 --project ./src/genocs.cli.csproj genocs -i
142+
# Run the tool to install the templates using the NET9 runtime
143+
dotnet run -f net9.0 --project ./src/genocs.cli.csproj genocs -i
143144

144145
# Run the tool to install the templates (some as above with cd command)
145146
cd ./src
146-
dotnet run -f net8.0 genocs -i
147+
dotnet run -f net9.0 genocs -i
147148

148149
# Install the tool from local folder to the global cache
149150
dotnet tool install --global --add-source ./src/nupkg genocs.cli
150151
```
152+
153+
## One in once
154+
155+
In the following section, you will find the commands to create a new service from scratch.
156+
For sake of simplicity, we will change the name of the service from `<Company.Project.Service>` to a demo name.
157+
158+
``` bash
159+
# To build a microservice web Api with multitenant support
160+
genocs micro-webapi n Genocs.TestWebApi
161+
162+
# To build a blazor portal
163+
genocs blazor-wasm new Genocs.TestWebBlazorPortal
164+
165+
# To restore and build the services
166+
dotnet restore ./Genocs.TestWebApi
167+
dotnet build ./Genocs.TestWebApi
168+
169+
dotnet restore ./Genocs.TestWebBlazorPortal
170+
dotnet build ./Genocs.TestWebBlazorPortal
171+
172+
# To run the API
173+
dotnet run --project ./Genocs.TestWebApi/src/WebApi/WebApi.csproj
174+
175+
# Run following command into another terminal
176+
dotnet run --project ./Genocs.TestWebBlazorPortal/src/Host/Host.csproj
177+
```
178+
179+
```mermaid
180+
architecture-beta
181+
group api(logos:aws-lambda)[Example]
182+
183+
service webapp(logos:aws-cognito)[WebApp] in api
184+
service webapi(logos:aws-lambda)[WebApi] in api
185+
service db(logos:aws-documentdb)[Database] in api
186+
187+
db:T -- B:webapi
188+
webapi:L -- R:webapp
189+
190+
```

layouts/index.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,16 @@ <h2 class="h4">ASP.NET MVC Template</h2>
178178
</div>
179179
</section>
180180

181+
<section class="section section-sm bg-light">
182+
<div class="container">
183+
<div class="justify-content-center text-center">
184+
<h2>Acknowledgements</h2>
185+
<p>This project uses a lot Open-Source libraries. Without them nothing was possible.</p>
186+
</div>
187+
<p></p>
188+
</section>
189+
190+
181191
<section class="section section-sm bg-light">
182192
<div class="container">
183193
<div class="justify-content-center text-center">

0 commit comments

Comments
 (0)