chore: update README and src

Author: huynxtb

.github/workflows/bild-and-deploy.yml

@@ -4,9 +4,6 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
 jobs:
   detect-changes:
@@ -948,13 +945,6 @@ jobs:
           tags: ${{ vars.DOCKERHUB_USERNAME }}/app-admin:latest,${{ vars.DOCKERHUB_USERNAME }}/app-admin:${{ github.sha }}
           cache-from: type=registry,ref=${{ vars.DOCKERHUB_USERNAME }}/app-admin:buildcache
           cache-to: type=registry,ref=${{ vars.DOCKERHUB_USERNAME }}/app-admin:buildcache,mode=max
-          build-args: |
-            VITE_KEYCLOAK_URL=${{ secrets.VITE_KEYCLOAK_URL }}
-            VITE_KEYCLOAK_REALM=${{ secrets.VITE_KEYCLOAK_REALM }}
-            VITE_KEYCLOAK_CLIENT_ID=${{ secrets.VITE_KEYCLOAK_CLIENT_ID }}
-            VITE_KEYCLOAK_REDIRECT_URI=${{ secrets.VITE_KEYCLOAK_REDIRECT_URI }}
-            VITE_KEYCLOAK_BASE_URL=${{ secrets.VITE_KEYCLOAK_BASE_URL }}
-            VITE_API_GATEWAY=${{ secrets.VITE_API_GATEWAY }}
 
   build-app-store:
     needs: detect-changes
@@ -986,13 +976,6 @@ jobs:
           tags: ${{ vars.DOCKERHUB_USERNAME }}/app-store:latest,${{ vars.DOCKERHUB_USERNAME }}/app-store:${{ github.sha }}
           cache-from: type=registry,ref=${{ vars.DOCKERHUB_USERNAME }}/app-store:buildcache
           cache-to: type=registry,ref=${{ vars.DOCKERHUB_USERNAME }}/app-store:buildcache,mode=max
-          build-args: |
-            VITE_KEYCLOAK_URL=${{ secrets.VITE_KEYCLOAK_URL }}
-            VITE_KEYCLOAK_REALM=${{ secrets.VITE_KEYCLOAK_REALM }}
-            VITE_KEYCLOAK_CLIENT_ID=${{ secrets.VITE_KEYCLOAK_CLIENT_ID }}
-            VITE_KEYCLOAK_REDIRECT_URI=${{ secrets.VITE_KEYCLOAK_REDIRECT_URI }}
-            VITE_KEYCLOAK_BASE_URL=${{ secrets.VITE_KEYCLOAK_BASE_URL }}
-            VITE_API_GATEWAY=${{ secrets.VITE_API_GATEWAY }}
 
   # Infrastructure Jobs
   build-api-gateway:

.github/workflows/ci.yml

@@ -1,9 +1,6 @@
 name: CI - Main Workflow
 
 on:
-  push:
-    branches:
-      - main
   pull_request:
     branches:
       - main

CONTRIBUTING.md

@@ -1,89 +1,97 @@
 # Contributing to ProG Coder Shop Microservices
 
-We welcome contributions to the ProG Coder Shop Microservices project! This document provides guidelines for contributing.
+Thank you for your interest in contributing to ProG Coder Shop Microservices! This guide will help you get started with building, testing, and contributing to the project.
 
-## How to Report Bugs
+## Table of Contents
 
-If you find a bug, please create an issue on GitHub with:
-- A clear description of the problem
-- Steps to reproduce the issue
-- Expected vs actual behavior
-- Your environment details (OS, .NET version, Docker version)
+- [Contributing to ProG Coder Shop](#contributing-to-prog-coder-shop-microservices)
+  - [Table of Contents](#table-of-contents)
+  - [Prerequisites](#prerequisites)
+    - [Required](#required)
+    - [Optional](#optional)
+  - [Getting Started](#getting-started)
+  - [Building the Project](#building-the-project)
+  - [Testing](#testing)
+    - [Quick Local Testing](#quick-local-testing)
+  - [Project Structure](#project-structure)
+  - [Code Style](#code-style)
+  - [Questions or Issues?](#questions-or-issues)
 
-## How to Submit Pull Requests
+## Prerequisites
 
-1. Fork the repository
-2. Create a new branch for your feature or bugfix (`git checkout -b feature/your-feature-name`)
-3. Make your changes
-4. Test your changes thoroughly
-5. Commit your changes with clear commit messages (see Commit Style below)
-6. Push to your fork
-7. Submit a pull request to the main repository
-
-## Commit Style
-
-We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
+### Required
 
-### Format
+- **[.NET SDK 8.0+](https://dotnet.microsoft.com/download/dotnet/8.0)** (specified in `src/Directory.Build.props`)
+- **[Docker Desktop](https://www.docker.com/products/docker-desktop)** (required for running services and infrastructure)
 
-```
-<type>(<scope>): <subject>
-```
+### Optional
 
-### Types
+- **[Node.js](https://nodejs.org/)** (v18+ recommended) - Required if you plan to work on the frontend applications in `src/Apps/`
+- **[Just](https://github.com/casey/just)** - Command runner (if you prefer using automation scripts)
 
-- **feat**: New feature
-- **fix**: Bug fix
-- **docs**: Documentation changes
-- **style**: Code formatting (no logic change)
-- **refactor**: Code restructuring
-- **perf**: Performance improvements
-- **test**: Test changes
-- **build**: Build system changes
-- **ci**: CI/CD changes
-- **chore**: Miscellaneous changes
+## Getting Started
 
-### Scope (Optional)
+0. (Optional) Comment on the related issue you want to work on
+1. Fork the repository
+2. Make a branch
+3. Make your changes
+4. Push the branch
+5. Make a pull request
 
-Service or component name: `catalog`, `basket`, `order`, `inventory`, `discount`, `notification`, `search`, `report`, `api-gateway`, `frontend`, etc.
+- There is a [**good first issue**](https://github.com/huynxtb/progcoder-shop-microservices/labels/good%20first%20issue) label for open issues
 
-### Examples
+## Building the Project
 
 ```bash
-# Feature
-feat(catalog): add MinIO image upload
+# Builds the whole solution
+dotnet build
+```
 
-# Bug fix
-fix(order): correct discount calculation
+## Testing
 
-# Documentation
-docs(readme): update setup instructions
+### Quick Local Testing
 
-# Multiple services
-refactor(catalog,inventory): extract common validation
+For most development work, you can simply run:
 
-# No scope
-chore: update dependencies
+```bash
+# Run all tests
+dotnet test
 ```
 
-### Rules
+### GitHub Actions Testing
+
+The project uses GitHub Actions for continuous integration:
+
+1. **CI Pipeline** (automatic)
+   - Triggers automatically on pull requests
+   - Runs validation for code quality, formatting, and tests.
 
-- Use imperative mood: "add" not "added"
-- Keep subject under 50 characters
-- No period at the end
-- Reference issues: `Closes #123`, `Fixes #456`
+## Project Structure
+
+```
+progcoder-shop-microservices/
+├── src/
+│   ├── ApiGateway/          # YARP API Gateway
+│   ├── Apps/                # Frontend Applications (React/Next.js)
+│   ├── JobOrchestrator/     # Background Jobs (Quartz.NET)
+│   ├── Services/            # Microservices (Basket, Catalog, Order, etc.)
+│   └── Shared/              # Shared libraries (Common, BuildingBlocks)
+├── test/                    # Test projects
+├── .github/                 # GitHub Actions workflows
+├── docker-compose.yml       # Docker composition for services
+└── samples/                 # Sample files
+```
 
 ## Code Style
 
-- Follow standard .NET coding conventions
-- Use meaningful variable and method names
-- Add comments for complex logic
-- Ensure your code builds without warnings
-- Run code formatter before committing (if available)
+The project enforces consistent code style:
 
-## Questions?
+- **Formatting**: We follow standard .NET coding conventions.
+- **Editor Configuration**: `.editorconfig` defines coding conventions enforced by the build.
+- **Regions**: We use `#region` directives for organizing code (e.g., `#region using`, `#region Properties`).
 
-If you have questions, feel free to open a GitHub issue or discussion.
+## Questions or Issues?
 
-Thank you for contributing!
+Check out [GitHub Issues](https://github.com/huynxtb/progcoder-shop-microservices/issues) or [discussions](https://github.com/huynxtb/progcoder-shop-microservices/discussions).
 
+Thank you for contributing to ProG Coder Shop Microservices!

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ProG Coder
+Copyright (c) 2026 ProG Coder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -12,6 +12,50 @@ Created by [**ProG Coder**](https://www.progcoder.com)
 
 ---
 
+## 📋 Table of Contents
+
+- [Project Overview](#-project-overview)
+  - [Architecture Diagram](#architecture-diagram)
+- [Technology Stack, Design Patterns, Infrastructure & Architecture](#technology-stack-design-patterns-infrastructure--architecture)
+  - [Infrastructure](#infrastructure)
+  - [Back-end](#back-end)
+  - [Front-end](#front-end)
+  - [Design Patterns](#design-patterns)
+  - [Architecture](#architecture)
+- [Microservices Overview](#microservices-overview)
+- [Infrastructure Services](#infrastructure-services)
+- [Web Applications](#web-applications)
+- [Web UI Screenshots](#web-ui-screenshots)
+- [Project Structure](#project-structure)
+- [Architecture & Design Patterns](#architecture--design-patterns)
+  - [Clean Architecture](#clean-architecture)
+  - [Domain-Driven Design (DDD)](#domain-driven-design-ddd)
+  - [CQRS](#cqrs-command-query-responsibility-segregation)
+  - [Event-Driven Architecture](#event-driven-architecture)
+  - [Saga Pattern](#saga-pattern)
+- [CI/CD Pipeline](#cicd-pipeline)
+- [Observability & Monitoring](#observability--monitoring)
+- [Data Infrastructure](#data-infrastructure)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Environment Configuration](#environment-configuration)
+  - [Quick Start](#quick-start-productiontesting-mode)
+  - [Development Mode](#development-mode)
+  - [Access URLs](#access-urls)
+  - [Default Credentials](#default-credentials)
+- [API Gateway Routes](#api-gateway-routes)
+- [Development](#development)
+  - [Running Individual Services](#running-individual-services)
+  - [Running Tests](#running-tests)
+  - [Database Migrations](#database-migrations)
+  - [Building Docker Images](#building-docker-images)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+
 ## 🚀 Project Overview
 
 This repository contains a comprehensive suite of microservices implementing a complete **e-commerce platform**, including **Catalog, Basket, Order, Inventory, Discount, Notification, Search, Report, and Communication** services. The platform utilizes a hybrid database strategy with **NoSQL (MongoDB, Redis)** and **Relational databases (PostgreSQL, SQL Server, MySQL)**.

progcoder-shop-microservices.sln

@@ -21,13 +21,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.env = .env
 		.env.sample = .env.sample
 		.gitignore = .gitignore
-		Courses.md = Courses.md
 		src\Directory.Build.props = src\Directory.Build.props
 		src\Directory.Packages.props = src\Directory.Packages.props
 		docker-compose.infrastructure.yml = docker-compose.infrastructure.yml
 		docker-compose.yml = docker-compose.yml
-		LICENSE = LICENSE
-		README.md = README.md
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Search", "Search", "{D54B29E6-15C1-4D82-B836-097C82983DEE}"

src/Services/Basket/Core/Basket.Application/Dtos/Baskets/BasketCheckoutAddressDto.cs

@@ -2,6 +2,8 @@ namespace Basket.Application.Dtos.Baskets;
 
 public sealed record BasketCheckoutAddressDto
 {
+    #region Fields, Properties and Indexers
+
     public string AddressLine { get; init; } = default!;
 
     public string Subdivision { get; init; } = default!;
@@ -13,6 +15,8 @@ public sealed record BasketCheckoutAddressDto
     public string Country { get; init; } = default!;
 
     public string PostalCode { get; init; } = default!;
+
+    #endregion
 }
 
 

src/Services/Basket/Core/Basket.Application/Dtos/Baskets/BasketCheckoutCustomerDto.cs

@@ -2,11 +2,15 @@ namespace Basket.Application.Dtos.Baskets;
 
 public sealed record BasketCheckoutCustomerDto
 {
+    #region Fields, Properties and Indexers
+
     public string Name { get; init; } = default!;
 
     public string Email { get; init; } = default!;
 
     public string PhoneNumber { get; init; } = default!;
+
+    #endregion
 }
 
 

src/Services/Basket/Core/Basket.Application/Dtos/Baskets/BasketCheckoutItemDto.cs

@@ -2,9 +2,13 @@ namespace Basket.Application.Dtos.Baskets;
 
 public sealed record BasketCheckoutItemDto
 {
+    #region Fields, Properties and Indexers
+
     public Guid ProductId { get; init; }
 
     public int Quantity { get; init; }
+
+    #endregion
 }
 
 

src/Services/Basket/Core/Basket.Domain/Attributes/BsonCollectionAttribute.cs

@@ -3,10 +3,18 @@
 [AttributeUsage(AttributeTargets.Class, Inherited = false)]
 public class BsonCollectionAttribute : Attribute
 {
+    #region Fields, Properties and Indexers
+
     public string CollectionName { get; }
 
+    #endregion
+
+    #region Ctors
+
     public BsonCollectionAttribute(string collectionName)
     {
         CollectionName = collectionName;
     }
+
+    #endregion
 }