# nguyenphuc22/design-patterns architecture

> Architecture diagram of the GitHub repository nguyenphuc22/design-patterns, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-03-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nguyenphuc22/design-patterns
- Repository: https://github.com/nguyenphuc22/design-patterns

## Overview

##### Dự án là gì (type + purpose)

Đây **không phải** là một “running system” kiểu web-app/backend service. Nó là một **repository sách/tài liệu** về Design Patterns (tiếng Việt), kèm:

- **Nội dung sách** dưới dạng Markdown (Writerside + docs/Book).
- **Code mẫu** (Java + Kotlin) minh hoạ các pattern (trong `src/...`).
- **Build tooling** (Gradle wrapper, `build.gradle`, `settings.gradle`) để build/pack tài liệu hoặc chạy demo (tuỳ cấu hình).
- **CI/CD** qua GitHub Actions (`.github/workflows/deploy.yml`) để build và **deploy** tài liệu (nhiều khả năng lên GitHub Pages hoặc một static hosting tương tự).

##### Authoring / Content layer
- `Writerside/`
- `topics/*.md`: nội dung chính (Intro, Creational/Structural/Behavioral, từng pattern).
- `writerside.cfg`, `cfg/*`, `buildprofiles.xml`: cấu hình build Writerside.
- `images/`: assets cho Writerside.
- `docs/Book/*.md`: bản “book format” (chương 1..6).
- `SUMMARY.md`: mục lục/điều hướng nội dung.
- `docs/images/**`: ảnh đã export/đính kèm theo từng pattern.

##### Code samples layer (minh hoạ pattern)
- `src/main/java/design/patterns/creational/singleton/*`: Java Singleton examples (+ README riêng).
- `src/structural patterns/**`: Kotlin examples (Composite/Decorator/Proxy…).
- `src/Behavioral Patterns/**`: Kotlin examples (Command…).

##### Build / Tooling / CI-CD
- `build.gradle`, `settings.gradle`, `gradle/wrapper/*`, `gradlew*`: build system (Gradle).
- `.github/workflows/deploy.yml`: pipeline deploy.
- `local.properties`: cấu hình local (không nên phụ thuộc runtime, nhưng có thể phục vụ build).

##### Project meta/community
- `CONTRIBUTING.md`, `LICENSE.md`, `.github/FUNDING.yml`: contribution & funding.
- README mô tả mục tiêu, ngôn ngữ hỗ trợ, cách đóng góp, liên kết issue.

##### (Tuỳ chọn) Content/Code Component Map (nội dung & code mẫu được tổ chức ra sao)

Bạn có thể dùng C4 Model làm khung, nhưng điều chỉnh cho phù hợp “documentation system”.

##### CI/CD: GitHub Actions
- workflow `deploy.yml`
##### Doc Builder
- Writerside build (input: topics/cfg/images; output: static site)
- (nếu Gradle orchestrate build) Gradle task runner
##### Static Site Hosting
- GitHub Pages / static hosting
##### End Users (Browser)
- consume static HTML/CSS/JS/assets

**Quan hệ**
- Repo → CI (trigger on push/merge)
- CI → Doc Builder (build)
- Builder → Hosting (publish artifacts)
- Browser ↔ Hosting (serve static)

##### Author edits
- `Writerside/topics/*.md`
- `docs/Book/*.md`
- code samples trong `src/...`
##### Commit/PR
- GitHub PR review (optional gate)
##### CI Build
- Checkout code
- Setup JDK/Gradle
- Run Writerside build (hoặc Gradle tasks)
- Generate static site artifacts
##### Deploy
- Upload artifacts → GitHub Pages (hoặc target khác)
##### Consume
- Reader loads pages
- (Optional) analytics events → GA

##### 4d) Component Map View (nội dung & code mẫu)
Ở view này, mục tiêu là “repo được tổ chức ra sao”, không phải runtime.

**Nên nhóm thành 4 cụm:**
- **Writerside content**: `Writerside/topics` + `Writerside/cfg` + `Writerside/images`
- **Book content**: `docs/Book` + `SUMMARY.md`
- **Code examples**:
- Java examples: `src/main/java/design/patterns/...`
- Kotlin examples: `src/structural patterns/**`, `src/Behavioral Patterns/**`
- Gắn tag “educational samples (non-production)”

Vẽ mũi tên:
- `*.drawio` → `docs/images/...` (exported images)
- Code examples ↔ referenced by docs (nếu docs có link tới code; nếu chưa rõ, dùng đường nét đứt “referenced in content”)

##### Quy tắc vẽ quan hệ / tương tác (để chính xác)

- “build static HTML”
- “publish artifact”
- “serve HTTP”

- **Gắn “source of truth” vào component**
- “Topics (Markdown) = source”
- “Images = generated/exported artifacts”

- **Writerside** (documentation engine)
- **Gradle + Gradle Wrapper** (`build.gradle`, `gradlew`)
- **GitHub Actions** (`deploy.yml`)
- **Java/Kotlin** (code samples)
- **Static hosting (GitHub Pages)** (suy đoán hợp lý từ workflow deploy; hãy xác nhận bằng `deploy.yml`)

- Màu xanh: Content sources (Markdown)
- Màu tím: Build/CI (Gradle, GitHub Actions)
- Màu cam: Artifacts/output (static site, exported images)
- Màu xám: External systems (GitHub, Hosting, GA, Payment)
- Cloud: Hosting/External

##### “Don’t overthink” nhưng tách tối đa component (đúng tinh thần yêu cầu)

- Writerside topics/config/images
- docs/Book + SUMMARY
- code samples (Java/Kotlin)
- CI workflow → tách thành:
- Trigger
- Build steps
- Artifact output
- Deploy step
- Hosting → tách:
- Static pages
- Static assets (images)
- (Optional) analytics script include

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =========================
  %% CONTEXT VIEW (Level 0)
  %% =========================
  subgraph "Context View (Who uses what?)"
    direction TB

    Reader["Reader / Learner\n(Browser)"]:::actor
    Contributor["Contributor / Author\n(Writes content, diagrams, samples)"]:::actor
    Maintainer["Maintainer\n(Review PR, manage releases)"]:::actor

    GitHub["GitHub\n(Repo + Issues + PR)"]:::external
    Actions["GitHub Actions\n(CI/CD)"]:::ci
    Hosting["Static Site Hosting\n(GitHub Pages or similar)"]:::external
    GA["Google Analytics\n(optional)"]:::external
    Payment["Payment Platforms\n(Momo / BuyMeACoffee links)"]:::external

    Contributor -->|"commit/PR"| GitHub
    Maintainer -->|"review/merge"| GitHub
    GitHub -->|"triggers_workflow"| Actions
    Actions -->|"deploy_static_site"| Hosting
    Reader -->|"HTTP_GET"| Hosting
    Hosting -.->|"analytics_events(optional)"| GA
    Reader -.->|"external_links"| Payment
  end

  %% =========================
  %% CONTAINER VIEW (Level 1)
  %% =========================
  subgraph "Container View (Documentation Platform Architecture)"
    direction TB

    Repo["GitHub Repository\n(Design Patterns VN: docs + examples)"]:::repo

    subgraph "Repository Contents (source-of-truth)"
      direction TB

      subgraph "Content Sources"
        direction TB
        WS_Topics["Writerside Topics\n(Markdown source)"]:::content
        WS_Cfg["Writerside Config\n(cfg/profiles/rules)"]:::content
        WS_Images["Writerside Images\n(assets)"]:::asset
        Book_MD["Book Chapters\n(Markdown)"]:::content
        Summary["SUMMARY.md\n(Table of contents)"]:::content
      end

      subgraph "Visual Assets"
        direction TB
        Drawio["Draw.io Sources\n(editable diagrams)"]:::diagramSrc
        ExportedImgs["Exported Images\n(embedded in docs)"]:::artifact
      end

      subgraph "Code Samples (Educational, non-production)"
        direction TB
        Java_Singleton["Java Samples\n(Singleton)"]:::code
        Kotlin_Behavioral["Kotlin Samples\n(Behavioral Patterns)"]:::code
        Kotlin_Structural["Kotlin Samples\n(Structural patterns)"]:::code
      end

      subgraph "Build and Meta"
        direction TB
        Gradle_Build["Gradle Build\n(build.gradle + wrapper)"]:::build
        Contrib["CONTRIBUTING / LICENSE / FUNDING / README"]:::meta
        LocalProps["local.properties\n(local-only)"]:::meta
      end
    end

    DocBuilder["Doc Builder\n(Writerside build orchestrated by Gradle)"]:::build
    StaticSite["Static Site Artifacts\n(HTML/CSS/JS + assets)"]:::artifact

    Repo -->|"contains"| WS_Topics
    Repo -->|"contains"| WS_Cfg
    Repo -->|"contains"| WS_Images
    Repo -->|"contains"| Book_MD
    Repo -->|"contains"| Summary
    Repo -->|"contains"| Drawio
    Repo -->|"contains"| ExportedImgs
    Repo -->|"contains"| Java_Singleton
    Repo -->|"contains"| Kotlin_Behavioral
    Repo -->|"contains"| Kotlin_Structural
    Repo -->|"contains"| Gradle_Build
    Repo -->|"contains"| Contrib
    Repo -->|"contains"| LocalProps

    Drawio -->|"export_diagram_PNG/SVG"| ExportedImgs

    WS_Topics -->|"build_inputs"| DocBuilder
    WS_Cfg -->|"build_inputs"| DocBuilder
    WS_Images -->|"build_inputs"| DocBuilder
    Book_MD -->|"content_source"| DocBuilder
    Summary -->|"navigation_source"| DocBuilder
    ExportedImgs -->|"assets"| DocBuilder
    Gradle_Build -->|"task_runner"| DocBuilder

    DocBuilder -->|"generate_static_HTML"| StaticSite
    StaticSite -->|"publish"| Hosting

    WS_Topics -.->|"reference_code_snippets"| Java_Singleton
    WS_Topics -.->|"reference_code_snippets"| Kotlin_Behavioral
    WS_Topics -.->|"reference_code_snippets"| Kotlin_Structural
    Book_MD -.->|"reference_code_snippets"| Java_Singleton
    Book_MD -.->|"reference_code_snippets"| Kotlin_Behavioral
    Book_MD -.->|"reference_code_snippets"| Kotlin_Structural
  end

  %% =========================
  %% PUBLISHING PIPELINE VIEW (Most important)
  %% =========================
  subgraph "Publishing Pipeline View (Authoring → Build → Deploy → Consume)"
    direction TB

    subgraph "Authoring"
      direction TB
      Edit_MD["Edit Markdown\n(Writerside/topics + docs/Book)"]:::content
      Edit_Drawio["Edit Draw.io\n(docs/diagrams)"]:::diagramSrc
      Export_Imgs["Export images\n(to docs/images or Writerside/images)"]:::artifact
      Edit_Code["Add/Update code samples\n(Java/Kotlin under src/...)"]:::code
    end

    subgraph "Version Control (GitHub)"
      direction TB
      CommitPR["Commit / Pull Request"]:::repo
      Review["Review + Merge (optional gate)"]:::repo
    end

    subgraph "CI Build (GitHub Actions: deploy.yml)"
      direction TB
      CI_Trigger["Workflow Trigger\n(push/merge)"]:::ci
      CI_Checkout["Checkout repository"]:::ci
      CI_Setup["Setup JDK + Gradle Wrapper"]:::ci
      CI_BuildDocs["Run Writerside/Gradle build\n(generate static site)"]:::ci
      CI_Artifact["Build Artifacts\n(static site bundle)"]:::artifact
    end

    subgraph "Deploy + Consumption"
      direction TB
      CI_Deploy["Deploy to Hosting\n(GitHub Pages or similar)"]:::ci
      Serve["Serve static pages + assets"]:::external
      Browser["Reader Browser\n(consumes docs)"]:::actor
      Analytics["Analytics Script Include\n(optional)"]:::external
    end

    Edit_MD -->|"commit_changes"| CommitPR
    Edit_Drawio -->|"commit_sources"| CommitPR
    Edit_Code -->|"commit_changes"| CommitPR
    Edit_Drawio -->|"export"| Export_Imgs
    Export_Imgs -->|"commit_assets"| CommitPR

    CommitPR -->|"PR_review"| Review
    Review -->|"merge_to_main"| CI_Trigger

    CI_Trigger -->|"run"| CI_Checkout
    CI_Checkout -->|"prepare_env"| CI_Setup
    CI_Setup -->|"build"| CI_BuildDocs
    CI_BuildDocs -->|"produce"| CI_Artifact
    CI_Artifact -->|"publish_artifact"| CI_Deploy

    CI_Deploy -->|"update_site"| Hosting
    Hosting -->|"serve_HTTP"| Browser
    Hosting -.->|"emit_events(optional)"| Analytics
  end

  %% =========================
  %% CLICK EVENTS (from component_mapping)
  %% =========================
  click WS_Topics "https://github.com/nguyenphuc22/design-patterns/tree/main/Writerside/topics/"
  click WS_Cfg "https://github.com/nguyenphuc22/design-patterns/blob/main/Writerside/cfg/buildprofiles.xml"
  click WS_Images "https://github.com/nguyenphuc22/design-patterns/tree/main/Writerside/images/"
  click Book_MD "https://github.com/nguyenphuc22/design-patterns/tree/main/docs/Book/"
  click Summary "https://github.com/nguyenphuc22/design-patterns/blob/main/SUMMARY.md"
  click Drawio "https://github.com/nguyenphuc22/design-patterns/tree/main/docs/diagrams/"
  click ExportedImgs "https://github.com/nguyenphuc22/design-patterns/tree/main/docs/images/"
  click Java_Singleton "https://github.com/nguyenphuc22/design-patterns/tree/main/src/main/java/design/patterns/creational/singleton/"
  click Kotlin_Behavioral "https://github.com/nguyenphuc22/design-patterns/tree/main/src/Behavioral Patterns/"
  click Kotlin_Structural "https://github.com/nguyenphuc22/design-patterns/tree/main/src/structural patterns/"
  click Gradle_Build "https://github.com/nguyenphuc22/design-patterns/blob/main/build.gradle"
  click DocBuilder "https://github.com/nguyenphuc22/design-patterns/blob/main/Writerside/writerside.cfg"
  click Repo "https://github.com/nguyenphuc22/design-patterns/blob/main/README.md"
  click LocalProps "https://github.com/nguyenphuc22/design-patterns/blob/main/local.properties"
  click Contrib "https://github.com/nguyenphuc22/design-patterns/blob/main/CONTRIBUTING.md"

  click CI_Deploy "https://github.com/nguyenphuc22/design-patterns/blob/main/.github/workflows/deploy.yml"
  click CI_Trigger "https://github.com/nguyenphuc22/design-patterns/blob/main/.github/workflows/deploy.yml"
  click CI_Checkout "https://github.com/nguyenphuc22/design-patterns/blob/main/.github/workflows/deploy.yml"
  click CI_Setup "https://github.com/nguyenphuc22/design-patterns/tree/main/gradle/wrapper/"
  click CI_BuildDocs "https://github.com/nguyenphuc22/design-patterns/blob/main/settings.gradle"

  click Edit_MD "https://github.com/nguyenphuc22/design-patterns/tree/main/Writerside/topics/"
  click Edit_Drawio "https://github.com/nguyenphuc22/design-patterns/tree/main/docs/diagrams/"
  click Export_Imgs "https://github.com/nguyenphuc22/design-patterns/tree/main/docs/images/"
  click Edit_Code "https://github.com/nguyenphuc22/design-patterns/tree/main/src/main/java/design/patterns/creational/singleton/"

  click CI_Setup "https://github.com/nguyenphuc22/design-patterns/tree/main/gradlew"
  click CI_Setup "https://github.com/nguyenphuc22/design-patterns/blob/main/gradlew.bat"
  click CI_Setup "https://github.com/nguyenphuc22/design-patterns/tree/main/gradle/wrapper/"

  click Contrib "https://github.com/nguyenphuc22/design-patterns/blob/main/LICENSE.md"
  click Contrib "https://github.com/nguyenphuc22/design-patterns/blob/main/.github/FUNDING.yml"
  click WS_Cfg "https://github.com/nguyenphuc22/design-patterns/blob/main/Writerside/cfg/google-analytics-noscript.html"

  %% =========================
  %% STYLES
  %% =========================
  classDef actor fill:#E3F2FD,stroke:#1565C0,stroke-width:1.5px,color:#0D47A1
  classDef external fill:#ECEFF1,stroke:#455A64,stroke-width:1.5px,color:#263238
  classDef repo fill:#F3E5F5,stroke:#6A1B9A,stroke-width:1.5px,color:#4A148C
  classDef content fill:#E8F5E9,stroke:#2E7D32,stroke-width:1.5px,color:#1B5E20
  classDef diagramSrc fill:#E0F7FA,stroke:#00838F,stroke-width:1.5px,color:#004D40
  classDef code fill:#FFF3E0,stroke:#EF6C00,stroke-width:1.5px,color:#E65100
  classDef build fill:#EDE7F6,stroke:#512DA8,stroke-width:1.5px,color:#311B92
  classDef ci fill:#E1BEE7,stroke:#7B1FA2,stroke-width:1.5px,color:#4A148C
  classDef artifact fill:#FFE0B2,stroke:#FB8C00,stroke-width:1.5px,color:#E65100
  classDef meta fill:#F5F5F5,stroke:#616161,stroke-width:1.2px,color:#212121
```
