Merge branch 'feature/Refactor' into develop

Author: minhsangdotcom

.github/workflows/github-cicd.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           dotnet-version: "8.0.406"
           cache: true
-          cache-dependency-path: "src/**/packages.lock.json"
+          cache-dependency-path: "**/packages.lock.json"
       - name: Install dependencies
         run: dotnet restore --locked-mode
       - name: Build

README-VIETNAMESE.md

@@ -4,12 +4,49 @@
 
 #
 
+![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE) ![GitHub Release](https://img.shields.io/github/v/release/minhsangdotcom/Clean-Architecture_The-Template?style=for-the-badge&color=orange)
+![GitHub Org's stars](https://img.shields.io/github/stars/minhsangdotcom%2FClean-Architecture_The-Template?style=for-the-badge&color=pink)
+![GitHub forks](https://img.shields.io/github/forks/minhsangdotcom/Clean-Architecture_The-Template?style=for-the-badge&color=%23f61d9c)
+
+# Bảng nội dung
+
+- [Ngôn ngữ](#)
+- [Nhãn](#)
+- [Bảng nội dung](#Bảng-nội-dung)
+- [Mô Hình Kiến Trúc Sạch (Clean Architecture)](#mô-hình-kiến-trúc-sạch-clean-architecture)
+- [Cho mình 1 ⭐ nhé](#cho-minh-1sao-nhe)
+- [Định Nghĩa](#định-nghĩa)
+  - [Lợi ích](#lợi-ích)
+  - [Nhược điểm](#nhược-điểm)
+- [Tính năng :rocket:](#tinh-nang)
+- [Nhá hàng cho các tính năng :fire:](#nha-hang-cho-cac-tinh-nang)
+  - [Authentication](#authentication)
+  - [Dynamic search and sort](#dynamic-search-and-sort)
+  - [Cross-cutting concerns](#cross-cutting-concerns)
+  - [Lưu trử file media bằng Minio](#lưu-trử-file-media-bằng-minio)
+  - [Tự động dịch message](#tự-động-dịch-message)
+- [Sơ lượt về Cấu trúc :mag_right:](#so-luot-ve-cau-truc)
+- [Bắt đầu thôi nào](#bắt-đầu-thôi-nào)
+  - [Cách để chạy ứng dụng](#cách-để-chạy-ứng-dụng)
+  - [Hướng dẫn sử dụng](#hướng-dẫn-sử-dụng)
+    - [Authorize](#authorize)
+    - [Thêm một quyền mới vào ứng dụng](#thêm-một-quyền-mới-vào-ứng-dụng)
+    - [Bộ lọc](#bộ-lọc)
+    - [Phân trang](#phân-trang)
+- [Công nghệ](#công-nghệ)
+- [Hỗ trợ](#hỗ-trợ)
+- [Lời cảm ơn](#lời-cảm-ơn)
+- [Cấp phép](#cấp-phép)
+
 # Mô Hình Kiến Trúc Sạch (Clean Architecture)
 
 Template này được thiết kế dành cho các bạn backend làm việc với ASP.NET Core. Nó cung cấp một cách hiệu quả để xây dựng các ứng dụng enterprise một cách đơn giản bằng cách tận dụng lợi thế từ kiến trúc Clean Architecture và .NET Core framework.
 
 Với template này, bạn sẽ có được zero configuration, không cần quan tâm đến cấu trúc, cài đặt, môi trường hoặc các thông lệ tốt nhất cho web API, vì tất cả đã được thiết lập :smiley:.
 
+<div id='cho-minh-1sao-nhe'/>
+
 # Cho mình 1 ⭐ nhé
 
 Nếu bạn thấy template này hữu ích và học được điều gì đó từ nó, hãy cân nhắc cho mình một :star:.
@@ -43,7 +80,9 @@ Quy tắc phụ thuộc nói rằng các thành phần phụ thuộc hướng t
 - **_Nguy cơ về cấu trúc quá phức tạp_**: Đối với các ứng dụng nhỏ, các tầng bổ sung có thể không cần thiết và dẫn đến sự phức tạp hóa.
 - **_Hiệu năng bị suy giảm_**: Sự trích dẫn và trừa tượng(interface) giữa các tầng có thể giảm hiệu năng, tuy nhiên thường là không đáng kể.
 
-# Features :rocket:
+<div id='tinh-nang'/>
+
+# Tính năng :rocket:
 
 Có gì đặc biệt khiến cho template này trở nên khác biệt so với những template khác có trên Github?
 
@@ -69,6 +108,8 @@ Nào hãy cùng mình khám phá nha :
 1. [Tự động dịch message](src/Contracts/Common/Messages/)
 1. [Mã nguồn mở và Cấp phép MIT](#license)
 
+<div id= 'nha-hang-cho-cac-tinh-nang'/>
+
 # Nhá hàng cho các tính năng :fire:
 
 ### Authentication
@@ -147,6 +188,8 @@ http://localhost:8080/api/Users?PageSize=2&Search.Keyword=N%E1%BA%B5ng&Search.Ta
 }
 ```
 
+<div id='so-luot-ve-cau-truc'/>
+
 # Sơ lượt về Cấu trúc :mag_right:
 
 **_Domain_**: Tầng Domain đóng vai trò như phần trung tâm trong Clean Architecture, các thành phần bao gồm:
@@ -556,7 +599,7 @@ Các bạn có thể tìm hiểu thêm ỏ một số link sau đây
 
 Mình thiết kế input đầu vào dựa trên [Strapi filter](https://docs.strapi.io/dev-docs/api/rest/filters-locale-publication)
 
-Mình đã nhúng sẳn filter tự động vào tất cả các hàm lấy danh sách ở  lớp Repository
+Mình đã nhúng sẳn filter tự động vào tất cả các hàm lấy danh sách ở lớp Repository
 
 ```csharp
     await unitOfWork
@@ -566,6 +609,7 @@ Mình đã nhúng sẳn filter tự động vào tất cả các hàm lấy danh
             query.ValidateQuery().ValidateFilter(typeof(ListUserResponse))
         );
 ```
+
 <div id='pagination'/>
 
 ### Phân trang
@@ -681,9 +725,12 @@ Offset and cursor pagination được tích hợp sẳn trong template.
 - Medator
 - XUnit, FluentAssertion, Respawn
 - OpenTelemetry
+- PostgreSQL
 - Redis
 - ElasticSearch
 - Serilog
+- Docker
+- Github Workflow
 
 # Hỗ trợ
 

README.md

@@ -3,20 +3,55 @@
 [English](README.md) | [Vietnamese](README-VIETNAMESE.md)
 
 #
-
-# .NET Core Clean Architecture The Template Introduction
+![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE) ![GitHub Release](https://img.shields.io/github/v/release/minhsangdotcom/Clean-Architecture_The-Template?style=for-the-badge&color=orange)
+![GitHub Org's stars](https://img.shields.io/github/stars/minhsangdotcom%2FClean-Architecture_The-Template?style=for-the-badge&color=pink)
+![GitHub forks](https://img.shields.io/github/forks/minhsangdotcom/Clean-Architecture_The-Template?style=for-the-badge&color=%23f61d9c)
+
+# Table of Contents
+- [1. Language](#1-languages)
+- [2. Badges](#2-badge)
+- [3. Table of Contents](#3-table-of-contents)
+- [2. .NET Core Clean Architecture The Template Introduction](#2-net-core-clean-architecture-the-template-introduction)
+- [3. Give a Star! ⭐](#3-give-a-star-)
+- [4. What is Clean Architecture?](#4-what-is-clean-architecture)
+    - [4.0.1 Advandtage](#401-advandtage)
+    - [4.0.2. Disadvandtage](402-disadvandtage)
+- [5. Features :rocket:](#5-features-rocket)
+- [6. Demo :fire:](#6-demo-fire)
+    - [6.0.1. Authentication](#601-authentication)
+    - [6.0.2. Dynamic search and sort](#602-dynamic-search-and-sort)
+    - [6.0.3. Cross-cutting concerns](#603-cross-cutting-concerns)
+    - [6.0.4. AWS S3 by Minio](#604-aws-s3-by-minio)
+    - [6.0.5. Automatic Translatable Message](#605-automatic-translatable-message)
+- [7. Structure Overview :mag\_right:](#7-structure-overview-mag_right)
+- [8. Getting started](#8-getting-started)
+  - [8.1. Run .NET Core Clean Architecture Project](#81-run-net-core-clean-architecture-project)
+  - [8.2. Basic Usage](#82-basic-usage)
+    - [8.2.1. Authorize](#821-authorize)
+    - [8.2.2. Create role with permissions:](#822-create-role-with-permissions)
+    - [8.2.3. How to add new permissions in your app](#823-how-to-add-new-permissions-in-your-app)
+    - [8.2.4. Filtering](#824-filtering)
+    - [8.2.5. Pagination](#825-pagination)
+- [9. Technology](#9-technology)
+- [10. Support](#10-support)
+- [11. Credits](#11-credits)
+- [12. Licence](#12-licence)
+
+
+# 2. .NET Core Clean Architecture The Template Introduction
 
 This template is designed for backend developer working with ASP.NET Core. It provides you an efficient way to build enterprise applications effortlessly by leveraging advantages of clean architecture structre and .NET Core framework.
 
 With this template, You'll benefit from zero configuration, and don't need to worry about struture, settings, environments or best practices for web APIs, because everything is already set up :smiley:.
 
-# Give a Star! ⭐
+# 3. Give a Star! ⭐
 
 If you find this template helpful and learn something from it, please consider giving it a :star:.
 
 Your support motivates me to deliver even better features and improvements in future versions.
 
-# What is Clean Architecture?
+# 4. What is Clean Architecture?
 
 Clean Architecture is a software design philosophy introduced by Robert C. Martin (Uncle Bob). It emphasizes the separation of concerns and promotes the organization of code into layers, each with distinct responsibilities. The architecture's primary goal is to create systems that are independent of frameworks, UI, databases, and external agencies, allowing flexibility, scalability, and testability.
 
@@ -26,7 +61,7 @@ At its core, Clean Architecture organizes code into concentric circles, with eac
 
 The dependency rule states that code dependencies should only point inward, ensuring that inner layers remain isolated from external layers.
 
-### Advandtage
+### 4.0.1 Advandtage
 
 - **_Seperation of Concerns_**: Each layer is responsible for a specific aspect of the application, making the code easier to understand and maintain.
 - **_Testability_**: Since business logic is decoupled from frameworks and UI, unit testing becomes simpler and more reliable.
@@ -35,15 +70,15 @@ The dependency rule states that code dependencies should only point inward, ensu
 - **_Scalability_**: The clear structure supports growth and the addition of new features without significant refactoring.
 - **_Framework Independence_**: Avoids being locked into a specific framework, making it easier to migrate to newer technologies.
 
-### Disadvandtage
+### 4.0.2. Disadvandtage
 
 - **_Complexity_**: The layered structure can add complexity, especially for smaller projects where simpler architectures might suffice.
 - **_Initial Overhead_**: Setting up Clean Architecture requires additional effort to organize layers and follow strict design principles.
 - **_Learning Curve_**: Developers unfamiliar with the principles may take time to grasp the structure and its benefits.
 - **_Over-Engineering Risk_**: For small-scale applications, the additional layers might be unnecessary and lead to over-complication.
 - **_Performance Overhead_**: The abstraction and indirection between layers can introduce slight performance trade-offs, though typically negligible.
 
-# Features :rocket:
+# 5. Features :rocket:
 
 What makes this Clean Architecture template stand out from the rest?
 
@@ -69,9 +104,9 @@ Let's explore the features:
 1. [Automactic translatable message](src/Contracts/Common/Messages/)
 1. [Open source and MIT license](#licence)
 
-# Demo :fire:
+# 6. Demo :fire:
 
-### Authentication
+### 6.0.1. Authentication
 
 ```json
 {
@@ -106,23 +141,23 @@ Let's explore the features:
 }
 ```
 
-### Dynamic search and sort
+### 6.0.2. Dynamic search and sort
 
 ```
 http://localhost:8080/api/Users?PageSize=2&Search.Keyword=N%E1%BA%B5ng&Search.Targets=province.name&Sort=dayOfBirth
 ```
 
 ![search and sort feature](Screenshots/search-sort.png)
 
-### Cross-cutting concerns
+### 6.0.3. Cross-cutting concerns
 
 ![Cross-cutting Concerns feature](Screenshots/crosscutting-concern.png)
 
-### AWS S3 by Minio
+### 6.0.4. AWS S3 by Minio
 
 ![AWS s3 feature](Screenshots/AWS_S3_Feature.png)
 
-### Automatic Translatable Message
+### 6.0.5. Automatic Translatable Message
 
 ```json
 {
@@ -147,7 +182,7 @@ http://localhost:8080/api/Users?PageSize=2&Search.Keyword=N%E1%BA%B5ng&Search.Ta
 }
 ```
 
-# Structure Overview :mag_right:
+# 7. Structure Overview :mag_right:
 
 **_Domain_**: Domain layer serves as the core of clean architecture application and contains key elements such as:
 
@@ -261,9 +296,9 @@ _It depends on Application and Infrastructure layer_
 
 **_Contract_** : Contains shared components for Application, Infrastructure and API layer.
 
-# Getting started
+# 8. Getting started
 
-## Run .NET Core Clean Architecture Project
+## 8.1. Run .NET Core Clean Architecture Project
 
 The following prerequisites are required to build and run the solution:
 
@@ -362,9 +397,9 @@ dotnet run
 
 Congrat! you are all set up :tada: :tada: :tada: :clap:
 
-## Basic Usage
+## 8.2. Basic Usage
 
-### Authorize:
+### 8.2.1. Authorize
 
 To Achieve this, let's add AuthorizeBy attribute on controller
 
@@ -382,7 +417,7 @@ To Achieve this, let's add AuthorizeBy attribute on controller
     }
 ```
 
-### Create role with permissions:
+### 8.2.2. Create role with permissions:
 
 Json payload is like
 
@@ -403,7 +438,7 @@ Json payload is like
 }
 ```
 
-### How to add new permissions in your app
+### 8.2.3. How to add new permissions in your app
 
 To get this, let's navigate to constants folder in Infrastructure layer, then open Credential.cs file and pay your attention on PermissionGroups Dictionary
 
@@ -467,7 +502,7 @@ public static class ObjectPermission
 
 Define your new one, then push it into PermissionGroups dictionary, and restart application.
 
-### Filtering
+### 8.2.4. Filtering
 
 To do filter in this template, we use LHS Brackets.
 
@@ -567,7 +602,7 @@ To Apply dynamic filter, you just call any list method at Repository class
         );
 ```
 
-### Pagination
+### 8.2.5. Pagination
 
 This template supports offset pagination and cursor pagination.
 
@@ -672,7 +707,7 @@ To Enable cursor pagination just add this line
 ```
 
 
-# Technology
+# 9. Technology
 
 - .NET 8
 - EntityFramework core 8
@@ -681,15 +716,18 @@ To Enable cursor pagination just add this line
 - Medator
 - XUnit, FluentAssertion, Respawn
 - OpenTelemetry
+- PostgreSQL
 - Redis
 - ElasticSearch
 - Serilog
+- Docker
+- Github Workflow
 
-# Support
+# 10. Support
 
 If you are having problems, please let me know by issue section.
 
-# Credits
+# 11. Credits
 
 :heart: Thank you guys so much :heart: :pray:.
 
@@ -711,6 +749,6 @@ If you are having problems, please let me know by issue section.
 - [Clean testing by Jayson Taylor](https://github.com/jasontaylordev/CleanArchitecture/tree/main/tests)\
   An inspiring repository of testing best practices, showcasing how to write robust and meaningful tests to ensure the reliability of clean architecture-based projects.
 
-# Licence
+# 12. Licence
 
 This project is licensed with the [MIT license](LICENSE).

docker-compose.yml

@@ -3,6 +3,7 @@ services:
     image: ghcr.io/${GITHUB_USER_NAME}/${IMAGE_NAME}:latest
     environment:
       - ASPNETCORE_ENVIRONMENT=Production
+      - urls=http://0.0.0.0:8080
     expose:
       - "8080"
     networks:

src/Api/Api.csproj

@@ -32,9 +32,9 @@
     <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.11.2" />
     <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.11.1" />
     <PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" Version="1.11.0-beta.2" />
-
     <PackageReference Include="Swashbuckle.AspNetCore" Version="7.3.1" />
     <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="7.3.1" />
+    <PackageReference Include="Ardalis.Result.AspNetCore" Version="8.0.0" />
   </ItemGroup>
 
   <PropertyGroup>