Skip to content

Commit

Permalink
refactor: update documentation for cqrs (#567)
Browse files Browse the repository at this point in the history
  • Loading branch information
sharonrussell authored Oct 31, 2024
1 parent 8f8c1e2 commit 1626b56
Showing 1 changed file with 15 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,15 @@ Solution xxENSONOxx.xxSTACKSxx.API
├── Shared
│ ├── xxENSONOxx.xxSTACKSxx.Shared.Messaging.Azure.ServiceBus
│ └── xxENSONOxx.xxSTACKSxx.Shared.Messaging.Azure.ServiceBus.Tests
└── Tests
├── xxENSONOxx.xxSTACKSxx.API.ComponentTests
├── xxENSONOxx.xxSTACKSxx.API.UnitTests
├── xxENSONOxx.xxSTACKSxx.Common.UnitTests
├── xxENSONOxx.xxSTACKSxx.CQRS.UnitTests
├── xxENSONOxx.xxSTACKSxx.Domain.UnitTests
├── xxENSONOxx.xxSTACKSxx.Infrastructure.IntegrationTests
└── xxENSONOxx.xxSTACKSxx.Infrastructure.UnitTests
├── Tests
│ ├── xxENSONOxx.xxSTACKSxx.API.ComponentTests
│ ├── xxENSONOxx.xxSTACKSxx.API.UnitTests
│ ├── xxENSONOxx.xxSTACKSxx.Common.UnitTests
│ ├── xxENSONOxx.xxSTACKSxx.CQRS.UnitTests
│ ├── xxENSONOxx.xxSTACKSxx.Domain.UnitTests
│ ├── xxENSONOxx.xxSTACKSxx.Infrastructure.IntegrationTests
│ └── xxENSONOxx.xxSTACKSxx.Infrastructure.UnitTests
└── xxENSONOxx.xxSTACKSxx.AppHost
```

#### xxENSONOxx.xxSTACKSxx.API
Expand Down Expand Up @@ -123,12 +124,16 @@ Component tests are similar to functional tests but with a key difference. Funct

**UnitTests** cover the Infrastructure project, including classes that handle cross-cutting concerns like logging, caching, and exception handling. They test middleware, filters, and other components that apply to the entire API.

#### xxENSONOxx.xxSTACKSxx.AppHost

The AppHost project is responsible for hosting the API and uses Aspire. Aspire is a lightweight, high-performance framework for building and hosting .NET applications. It provides essential features like dependency injection, configuration management, and middleware support.

The AppHost project contains the Program.cs class, which configures the API and starts the host. The AppHost project should be kept as simple as possible to avoid adding unnecessary dependencies or logic.

:::note Further Reading

For more information on CQRS, you can refer to the following resource:

[CQRS Documentation](https://martinfowler.com/bliki/CQRS.html) by Martin Fowler

:::


0 comments on commit 1626b56

Please sign in to comment.