vertical-slice-architecture-template - GitLite

KO | EN

gitlite — search

#typescript #go #machine-learning #rust #docker #nodejs #java #awesome #cli #kubernetes #awesome-list #pytorch #security #mcp

vertical-slice-architecture-template

(★ 286)

Vertical Slice Architecture Template for .NET 10

파일 탐색기

최종 버전 다운로드 (.zip)

- FUNDING.yml
- - LoggingBehavior.cs
  - ValidationBehavior.cs
- - ApplicationDbContext.cs
- - Product.cs
- - GlobalExceptionHandler.cs
- - DatabaseExtensions.cs
  - HealthChecksExtensions.cs
  - MediatRExtensions.cs
  - ResultExtensions.cs
- - 20241004002300_Initial.cs
  - 20241004002300_Initial.Designer.cs
  - ApplicationDbContextModelSnapshot.cs
- - launchSettings.json
- appsettings.Development.json
- appsettings.json
- GlobalUsing.cs
- Program.cs
- VSATemplate.csproj
- VSATemplate.http
- VSATemplate.Tests.csproj
.gitattributes
.gitignore
LICENSE.txt
README.md
VSATemplate.sln
VSATemplate.slnx

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/poorna-soysa/vertical-slice-architecture-template

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vertical-slice-architecture-template

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vertical Slice Architecture Template

This repository provides a template for building applications using the Vertical Slice Architecture with .NET 10. It includes implementations for CQRS, MediatR, global exception handling, Carter library, FluentValidation, EF Core, and the result pattern.

## Table of Contents

- [Getting Started](#getting-started)
- [Architecture Overview](#architecture-overview)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Folder Structure](#folder-structure)
- [Setup](#setup)
- [Contributing](#contributing)
- [License](#license)
- [Support](#support)

## Getting Started

To get a local copy up and running, follow these simple steps.

### Prerequisites

- [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0)

### Installation

1. Clone the repo
   ```sh
   git clone https://github.com/poorna-soysa/vertical-slice-architecture-template.git
   ```
2. Navigate to the project directory
   ```sh
   cd vertical-slice-architecture-template
   ```
3. Restore dependencies
   ```sh
   dotnet restore
   ```

## Architecture Overview

This template follows the Vertical Slice Architecture, which organizes code by features rather than technical concerns. Each feature is self-contained, promoting high cohesion and low coupling.

## Features

- **CQRS**: Command and Query Responsibility Segregation.
- **MediatR Library**: Implements the mediator pattern for handling requests and notifications.
- **Global Exception Handling**: Centralized handling of exceptions.
- **Carter Library**: Lightweight library for building HTTP APIs.
- **FluentValidation Library**: Validation library for .NET.
- **Entity Framework Core**: Object-relational mapper for .NET.
- **Result Pattern**: Standardized way of handling operation results.
- **Health Checks**: Standardized approach for monitoring and assessing the operational status of systems.

## Technologies Used

- **.NET 10**
- **CQRS**
- **MediatR**
- **Carter Library**
- **FluentValidation**
- **EF Core**
- **HealthChecks Library**

## Folder Structure

- **/src**: Contains the main application code.
  - **/Features**: Each feature is organized into its own folder, promoting encapsulation.
    - **/Products**: Contains all product related files for the feature.
       - **/CreateProduct**:  Logic for creating a product.
       - **/DeleteProduct**: Logic for deleting a product.
       - **/GetProductById**: Logic for retrieving a product by its Id.
       - **/GetProducts**: Logic for retrieving a list of products.
       - **/UpdateProduct**: Logic for updating product details.
       - **ProductErrors**: Contains all product-related error handling.
    - **FeatureXController.cs**: Entry point for HTTP requests related to the feature.
  - **/Abstractions**: Contains shared interfaces and contracts.
     - **/CQRS**: Contains all CQRS abstraction interfaces.
     - **/Errors**: Define Error class.
     - **/ResultResponse**: Standardized response structures for API results.
  - **/Behaviors**: Contains middleware and behaviors that apply to requests and responses.
  - **/Database**: Contains database-related code, including DB Context.
  - **/Entities**: Defines the core data models used throughout the application.
  - **/Exceptions**: Contains the global exception handler for the application.
  - **/Extensions**: Contains extension methods for various classes and services.
  - **/Migrations**: Database migration files for schema updates.
  - **Program.cs**: Application entry point.

- **/tests**: Contains unit and integration tests for the features and common components.

## Setup

1. Configure your database connection string in `appsettings.json`.
2. Run the application
   ```sh
   dotnet run
   ```

## Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Support

If you find this project helpful, consider buying me a coffee!

[![Buy Me a Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/poorna.soysa)
```