Skip to content

Commit f94d68a

Browse files
committed
Refactor README and remove redundant files
- Updated README.md to streamline the installation and usage instructions for the Genocs Clean Architecture Template. - Removed the src/README.md file as it was redundant and contained outdated information. - Deleted obsolete Azure DevOps pipeline YAML files related to Docker and Kubernetes configurations. - Added new Kubernetes ingress and deployment YAML files to the template structure. - Updated paths and service names in the README to reflect the latest changes in the project structure.
1 parent d030b7f commit f94d68a

9 files changed

+11
-314
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -112,25 +112,14 @@ dotnet new install Genocs.CleanArchitecture.Template
112112
# Or install a specific version
113113
dotnet new install Genocs.CleanArchitecture.Template::4.0.0
114114

115-
# Create a new microservice
116-
dotnet new cleanarchitecture --name "MyCompany.MyService" --database mongodb --servicebus masstransit
117-
118-
# Navigate to the project directory
119-
cd MyCompany.MyService
120-
121-
# Build and run
122-
dotnet build
123-
dotnet test
124-
dotnet run --project src/MyCompany.MyService.WebApi
125-
126115
# View all available options
127116
dotnet new cleanarchitecture --help
128117

129118
# Example with custom options
130119
dotnet new cleanarchitecture \
131-
--name "Acme.InventoryService" \
132-
--database sqlserver \
133-
--servicebus particular \
120+
--name "CompanyName.ServiceName" \
121+
--database inmemory \
122+
--service-bus rebus \
134123
--use-cases full
135124
```
136125

@@ -140,12 +129,16 @@ The template generates a solution with the following structure:
140129

141130
```pl
142131
src/
143-
├── Domain/ # Core business logic and entities
132+
├── AcceptanceTests/ # Acceptance Tests
144133
├── Application/ # Use cases and application services
134+
├── Contracts/ # API and ServiceBus contracts and commansd, events and messages
135+
├── Contracts.NServiceBus/ # API and ServiceBus contracts and commansd, events and messages, used by NServiceBus
136+
├── Domain/ # Core business logic and entities
145137
├── Infrastructure/ # Data access and external services
138+
├── IntegrationTests/ # Integration Tests
139+
├── UnitTests/ # Unit Tests
146140
├── WebApi/ # REST API controllers and middleware
147141
├── Worker/ # Background services and message handlers
148-
├── Contracts.NServiceBus/ # NServiceBus contracts and events
149142
└── Contracts/ # API contracts and events
150143
```
151144

@@ -179,7 +172,7 @@ dotnet new cleanarchitecture --help
179172
dotnet new uninstall Genocs.CleanArchitecture.Template
180173

181174
# Example of creating a new project with InMemory database and Rebus as service bus
182-
dotnet new cleanarchitecture --name {MyCompany.MyProject} -da inmemory -sb rebus
175+
dotnet new cleanarchitecture --name {CompanyName.ServiceName} -da inmemory -sb rebus
183176
```
184177

185178
### Miscellaneous
@@ -200,7 +193,7 @@ dotnet new list
200193

201194
```bash
202195
# Start infrastructure services
203-
docker-compose -f docker-infrastructure/docker-compose-infrastructure.yml up -d
196+
docker-compose -f ./infrastructure/docker/docker-compose-infrastructure.yml up -d
204197

205198
# Run the API
206199
dotnet run --project src/YourProject.WebApi

src/README.md

Lines changed: 0 additions & 296 deletions
This file was deleted.

0 commit comments

Comments
 (0)