Skip to content

Commit fa5eea8

Browse files
committed
Refactor code structure for improved readability and maintainability
1 parent f94d68a commit fa5eea8

File tree

3 files changed

+30
-38
lines changed

3 files changed

+30
-38
lines changed

README.md

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -45,27 +45,12 @@
4545
[twitterx-url]: https://twitter.com/genocs
4646

4747
<p align="center">
48-
<img src="./assets/genocs-library-logo.png" alt="icon">
48+
<img src="./assets/ExagonalArchitecture.png" alt="Genocs Library Logo">
4949
</p>
5050

5151
# Genocs Clean Architecture Template
5252

53-
A comprehensive .NET 9 project template that follows Clean Architecture principles and Domain-Driven Design (DDD).
54-
55-
This template helps you rapidly scaffold microservices applications with built-in support for multiple databases, message brokers, and enterprise patterns.
56-
57-
## 📋 Table of Contents
58-
59-
- [Features](#features)
60-
- [Prerequisites](#prerequisites)
61-
- [Quick Start](#quick-start)
62-
- [Installation](#installation)
63-
- [Usage](#usage)
64-
- [Template Options](#template-options)
65-
- [Architecture Overview](#architecture-overview)
66-
- [Examples](#examples)
67-
- [Contributing](#contributing)
68-
- [Support](#support)
53+
A comprehensive .NET 9 project template that follows Clean Architecture principles and Domain-Driven Design (DDD). This template helps you rapidly scaffold microservices applications with built-in support for multiple databases, message brokers, and enterprise patterns.
6954

7055
## ✨ Features
7156

@@ -77,18 +62,21 @@ This template helps you rapidly scaffold microservices applications with built-i
7762
- 🔍 **Observability** - OpenTelemetry tracing and monitoring
7863
- 🐳 **Containerization** - Docker and Kubernetes ready
7964
-**Background Services** - Worker services for async processing
65+
- 🧪 **Comprehensive Testing** - Unit, Integration, and Acceptance tests
8066

81-
### Databases supported:
82-
83-
- InMemoryDB (for development purpose)
84-
- SqlServer
85-
- MongoDB
86-
87-
### Enterprise Service Bus libraries supported:
67+
## 📋 Table of Contents
8868

89-
- Particular NServiceBus
90-
- MassTransit
91-
- Rebus
69+
- [Features](#features)
70+
- [Prerequisites](#prerequisites)
71+
- [Quick Start](#quick-start)
72+
- [Template Options](#template-options)
73+
- [Architecture Overview](#architecture-overview)
74+
- [Development Workflow](#development-workflow)
75+
- [Examples](#examples)
76+
- [Troubleshooting](#troubleshooting)
77+
- [Community & Support](#community--support)
78+
- [Contributing](#contributing)
79+
- [License](#license)
9280

9381
## 📋 Prerequisites
9482

@@ -149,7 +137,6 @@ src/
149137
- **Infrastructure Layer**: Repositories, message brokers, databases
150138
- **Presentation Layer**: Controllers, middleware, API documentation
151139

152-
153140
## How to build and install the template locally
154141

155142
To build the package run the following commands:
@@ -234,12 +221,10 @@ dotnet test src/AcceptanceTests
234221

235222
### Common Issues
236223

237-
238224
For more details on getting started, [read the documentation](https://genocs-blog.netlify.app/library/)
239225

240226
Please check the [documentation](https://learn.microsoft.com/en-us/visualstudio/ide/how-to-locate-and-organize-project-and-item-templates?view=vs-2022) for more details.
241227

242-
243228
## Changelogs
244229

245230
View Complete [Changelogs](https://github.com/Genocs/clean-architecture-template/blob/main/CHANGELOGS.md).
@@ -269,3 +254,12 @@ Become a financial contributor and help me sustain the project.
269254
<a href="https://opencollective.com/genocs"><img src="https://opencollective.com/genocs/individuals.svg?width=890"></a>
270255

271256
## Acknowledgements
257+
258+
## ⚙️ Template Options
259+
260+
| Option | Description | Values | Default |
261+
| -------------- | ------------------- | ------------------------------------ | ------------- |
262+
| `--name` | Project name | `{Company.Project.Service}` | Required |
263+
| `--database` | Database provider | `inmemory`, `sqlserver`, `mongodb` | `inmemory` |
264+
| `--servicebus` | Message broker | `particular`, `masstransit`, `rebus` | `masstransit` |
265+
| `--use-cases` | Use case complexity | `basic`, `full`, `readonly` | `basic` |

assets/ExagonalArchitecture.png

99.1 KB
Loading

src/Package.Template.nuspec

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ The full clean project:
2424
$ dotnet new cleanarchitecture
2525
</description>
2626
<releaseNotes>
27-
- Relesase 3.1.0:
28-
Added list of events
29-
30-
- Clean Architecture Principles Documentation
31-
- .NET9
32-
- Swashbuckle 5
33-
- Entity Framework Core 5
34-
- Enterprice Service Bus
27+
Release notes:
28+
- Release 4.0.0:
29+
- Updated to .NET 9
30+
- Improved Docker support
31+
- Added new templates for CQRS and Event Sourcing
32+
3533
</releaseNotes>
3634
<tags>
3735
aggregate

0 commit comments

Comments
 (0)