# bdu-fira/22050026_tramgianguyen_cd1 architecture

> Architecture diagram of the GitHub repository bdu-fira/22050026_tramgianguyen_cd1, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bdu-fira/22050026_tramgianguyen_cd1
- Repository: https://github.com/bdu-fira/22050026_tramgianguyen_cd1

## Overview

##### Project type and purpose
- This is a full-stack e-commerce platform (Gamine) for gaming gear, comprising three main parts:
- Public website (React)
- Admin panel (React + TypeScript)
- Backend REST API (Django + DRF + PostgreSQL)
- It supports product browsing, cart & checkout, user accounts, promotions, plus a management interface for products, orders, users, content, and stats.

##### File structure
- Two deployment variants:
a. project-docker/ – Dockerized version with Dockerfiles for each service and a docker-compose.yml
b. gamine-local/ – Local development version with the same three subprojects
- Top-level subfolders under each variant:
- gamine-react/ – client-facing storefront (React JS)
- admin-panel/ – administrative UI (React TS)
- admin/backend/ – Django project (settings, URLs, ASGI/WGSI) plus “core” app with models, serializers, views, migrations, commands
- Supporting files:
- Dockerfile & nginx.conf in gamine-react & admin-panel for container image & static-asset serving
- docker-compose.yml orchestrating three containers plus DB (PostgreSQL)
- package.json, tsconfig.json, requirements.txt

##### README for additional insights
- Confirms 3-tier architecture: frontend, admin UI, backend
- Lists tech stack: React, TS, Material UI, Django REST Framework, JWT auth, PostgreSQL, Nginx, Docker
- Describes endpoints & ports for each service

a. Main components
- Browser (end user or admin user)
- Public Website container (React)
- Admin Panel container (React TS)
- Nginx reverse proxy (in each web container)
- Backend API container (Django + DRF)
- Database container (PostgreSQL)
- Docker Compose orchestration

b. Relationships & interactions
- Browser → HTTP(S) → Nginx (React apps)
- React apps → HTTP(S) REST → Django API (/api/…)
- Django API → SQL → PostgreSQL
- Admin panel and public site share the same API but different routes/permissions
- JWT Authentication issued by API → stored in browser by React → sent on subsequent API calls

c. Architectural patterns & design principles
- 3-tier separation (presentation → application → data)
- Containerized micro-services (each UI + API isolated)
- RESTful API pattern powered by Django REST Framework
- Role-based access control in Admin (PermissionRoute components, DRF permissions)
- React componentization and Context API for state (AuthContext, SessionManager)

d. Key technologies & libraries
- React, React Router, Context API (AuthContext, ProtectedRoute)
- Material UI (for Admin styling)
- Django, Django REST Framework, JWT
- PostgreSQL (persistent data store)
- Docker & docker-compose, Nginx (static serving + proxy)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients
    Browser["Web Browser"]:::client

    %% Docker Compose cluster
    subgraph "Docker Compose" 
        direction TB
        Compose["docker-compose.yml"]:::infra

        subgraph "Storefront Container" 
            direction TB
            SF_Nginx["Nginx\n(static + proxy)"]:::infra
            SF_React["React App\n(Storefront)"]:::frontend
            SF_AuthContext["AuthContext"]:::frontend
            SF_APIClient["API Client\n(src/api/index.js)"]:::frontend
            SF_Components["Components & Pages"]:::frontend
        end

        subgraph "Admin Panel Container"
            direction TB
            AP_Nginx["Nginx\n(static + proxy)"]:::infra
            AP_React["React TS App\n(Admin)"]:::frontend
            AP_AuthContext["AuthContext"]:::frontend
            AP_ProtectedRoute["ProtectedRoute"]:::frontend
            AP_APIService["API Service Wrapper"]:::frontend
        end

        subgraph "Backend API Container"
            direction TB
            BE_Entrypoint["docker-entrypoint.sh"]:::infra
            BE_Django["Django App"]:::backend
            BE_Settings["settings.py"]:::backend
            BE_URLs["urls.py"]:::backend
            subgraph "Core App"
                direction TB
                Core_models["models.py"]:::backend
                Core_serializers["serializers.py"]:::backend
                Core_views["views.py"]:::backend
                Core_permissions["permissions.py"]:::backend
                Core_auth["authentication.py"]:::backend
                Core_urls["core/urls.py"]:::backend
                Core_commands["init_admin.py"]:::backend
            end
            BE_manage["manage.py"]:::backend
        end

        subgraph "PostgreSQL Database"
            DB["PostgreSQL\n5432"]:::database
        end
    end

    %% Relationships
    Browser -->|HTTP:3000| SF_Nginx
    Browser -->|HTTP:3001| AP_Nginx
    SF_Nginx -->|proxy| SF_React
    AP_Nginx -->|proxy| AP_React
    SF_React -->|REST API:8000| BE_Django
    AP_React -->|REST API:8000| BE_Django
    BE_Django -->|SQL:5432| DB

    %% Infrastructure link
    Compose --> SF_Nginx
    Compose --> AP_Nginx
    Compose --> BE_Entrypoint
    Compose --> DB

    %% Click Events
    click SF_React "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/tree/master/gamine-local/gamine-react/"
    click AP_React "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/tree/master/gamine-local/admin-panel/"
    click BE_Django "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/tree/master/gamine-local/admin/backend/"
    click BE_Settings "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/backend/settings.py"
    click BE_URLs "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/backend/urls.py"
    click Core_models "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/models.py"
    click Core_serializers "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/serializers.py"
    click Core_views "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/views.py"
    click Core_permissions "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/permissions.py"
    click Core_auth "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/authentication.py"
    click Core_urls "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/urls.py"
    click Core_commands "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/core/management/commands/init_admin.py"
    click BE_manage "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin/backend/manage.py"
    click SF_AuthContext "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/gamine-react/src/services/AuthContext.js"
    click SF_APIClient "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/gamine-react/src/api/index.js"
    click SF_Components "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/tree/master/gamine-local/gamine-react/src/components/"
    click AP_AuthContext "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin-panel/src/contexts/AuthContext.tsx"
    click AP_ProtectedRoute "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin-panel/src/components/ProtectedRoute.tsx"
    click AP_APIService "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/gamine-local/admin-panel/src/services/api.ts"
    click Compose "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/project-docker/docker-compose.yml"
    click SF_Nginx "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/project-docker/gamine-react/nginx.conf"
    click AP_Nginx "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/project-docker/admin-panel/nginx.conf"
    click BE_Entrypoint "https://github.com/bdu-fira/22050026_tramgianguyen_cd1/blob/master/project-docker/admin/backend/docker-entrypoint.sh"
    classDef frontend fill:#e0f7da,stroke:#2e7d32,color:#2e7d32
    classDef backend fill:#e3f2fd,stroke:#1565c0,color:#1565c0
    classDef database fill:#ffe0b2,stroke:#ef6c00,color:#ef6c00
    classDef infra fill:#eeeeee,stroke:#757575,color:#424242
    classDef client fill:#f3e5f5,stroke:#6a1b9a,color:#6a1b9a
```
