sswconsulting / ssw.verticalslicearchitecture Goto Github PK

An enterprise ready solution template for Vertical Slice Architecture. This template is just one way to apply the Vertical Slice Architecture.

Home Page: https://verticalslicearchitecture.com/

License: MIT License

C# 100.00%

asp-net-core dotnet minimal-endpoints software-architecture vertical-slice-architecture ef-core

ssw.verticalslicearchitecture's Introduction

🤔 What is it?

An enterprise ready solution template for Vertical Slice Architecture. This template is just one way to apply the Vertical Slice Architecture.

Learn

🎉 Getting Started

To install the template from NuGet.org run the following command:

dotnet new install SSW.VerticalSliceArchitecture.Template

Then create a new solution:

mkdir Sprout
cd Sprout

dotnet new ssw-vsa

Finally, to update the template to the latest version run:

dotnet new update

📚 Faster Development

To speed up development there is a dotnet new template to create a full Vertical Slice.

dotnet new ssw-vsa-slice -f Student

-f or --feature where the feature name is the singular name of the feature.

Of course, there are always exceptions where appending an 's' is not enough. For example, Person becomes People and Child becomes Children.

For this, use the optional parameter:

dotnet new ssw-vsa-slice -f Person -fp People

optional: -fp or --feature-plural where the feature name is the plural name of the feature.

This creates everything you need to get started with a new feature.

Full CRUD endpoints
CQRS
- missing EventHandlers/ folder as this is more uncommon
- provides Events/ as a folder to demonstrate how to trigger side effects
Basic REPR pattern (i.e., Request, an Endpoint, and a Response)
Adds a new Entity
Basic DDD pattern - the 'Complete' method on the entity shows adding Domain events and using Result objects instead of exceptions for validation
Adds a DbSet to the DbContext
Adds EF Core Entity Type Configuration
Adds a Repository

While there is a small amount of code to remove, it is better to push you towards the pit of success, than allow inconsistency.

📝 Architecture

graph TD;
    subgraph ASP.NET Core Web App
        subgraph Slices
            A[Feature A]
            B[Feature B]
        end
        Slices --> |depends on| Common
        Host --> |depends on| Common
        Host --> |depends on| Slices
        ASPNETCore[ASP.NET Core] --> |uses| Host
    end

    Common[Common]

✨ Features

C# 12
.NET 8
ASP.NET Core
Minimal APIs
EF Core
Swagger UI

ssw.verticalslicearchitecture's People

Contributors

Stargazers

Watchers

ssw.verticalslicearchitecture's Issues

🧪 Meta Integration Test - Delete Todo Feature & app still compiles

dotnet new hona-vsa
rm -rf ./Features
dotnet build

🧪 Add integration tests using Test Containers

Apply model config from assembly

Change code to

namespace TempusHub.API.Common;

public partial class AppDbContext : DbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }

    // 👇 New code
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(AppDbContext).Assembly);
    }
    // 👆 New code
}

⚡ Use IReadOnlyList & .ToListAsync

.ToArrayAsync literally calls ToListAsync.ToArray 🤦🏻‍♂️

Get VSA Template to GA

TODO: Break this down into whatever work is required

🤔 Consider OpenTelemetry

Track

Mass Transit
ASP.NET Core OOTB stuff

Fast command for Tests Core.Unit

Maybe something like dotnet new ssw-vsa-slice -t (test) Student

And this add
Features

Student
- Models

Its only an idea maybe something else :=)

♻️ Rename IModule to ISlice

🗑️ Remove DDD style Results pattern

It's far too much boilerplate when the core idea is 'move fast, abstract later when needed'

Leave your thoughts below :)

♻️ Decouple endpoints from logic.

Tests should not have to deal with a Result object

👷🏻 GitHub Release Flow

1 source of truth.

Probably a commit that changes the nuspec version, will then tag & create a github release.

🗑️ Drop Open API extensions

WebApi/ should just use the normal minimal endpoint stuff

✨ Add flag to include Blazor Web App & pages inside slices

📺 Create a reference application that is non-trivial

🧪 Architecture Tests to Enforce Constraints

ACs

Add architecture tests that will detect if classes are not referencing the correct things.
The tests will be enforced by namespaces
Restrict that
a. Application Cannot reference Infrastructure
b. Domain cannot Reference Infrastructure
c. Domain cannot Reference Application