# minhduc29/gmu-connect architecture

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

- Interactive diagram: https://gitdiagram.com/minhduc29/gmu-connect
- Repository: https://github.com/minhduc29/gmu-connect

## Overview

##### Project type and purpose
- gmu-matchmaker is a full-stack web application combining a React/Vite single‐page-app frontend with a Django REST + Channels backend.
- It provides user authentication (JWT), user profiles, posts, and real-time chat via WebSockets.

##### File structure
- Top-level split: “frontend/” (React code) and “backend/” (Django project).
- backend/
- Django project under backend/backend/ (settings, ASGI/WGI entrypoints, JWT middleware)
- Four Django apps: users, profiles, posts, chat
- Dockerfile & docker-compose.yml for container orchestration
- frontend/
- Vite-powered React app (package.json, vite.config.js, index.html)
- src/ holds pages, components (Layout, NavBar, ProtectedRoute), services (REST + WebSocket clients), context (AuthContext), utils, and CSS styles

##### README
- README.md only contains the project name; no additional architectural notes. All inferences come from the file layout and dependencies.

a. Main components
- Frontend SPA (React + Vite)
- Backend monolith (Django REST framework + Django Channels)
- Database (e.g., Postgres or SQLite as defined in settings)
- Channel layer / message broker (e.g., Redis) for WebSocket routing
- External clients (Web browser, mobile)
b. Relationships & interactions
- Browser ↔ HTTP REST (Axios or fetch via api.js) ↔ Django REST endpoints (users/profiles/posts)
- Browser ↔ WebSocket (websocketService.js) ↔ Django Channels consumers via ASGI
- Django apps ↔ ORM ↔ Database
- Channels layer ↔ Redis broker ↔ multiple worker instances
c. Architectural patterns / design principles
- SPA front/back separation
- Layered backend (URL routing → views/consumers → serializers → models → DB)
- JWT authentication middleware for stateless sessions
- Pub/Sub model for chat via Channels + Redis
d. Key technologies & libraries
- Frontend: React, Vite, Context API, JSX, CSS modules
- Backend: Python 3, Django, Django REST Framework, Django Channels
- Middleware: Custom JWT auth
- Datastore: PostgreSQL/SQLite
- Broker: Redis (channels_redis)
- Containerization: Docker & docker-compose

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Zone
    subgraph "Frontend" 
        direction TB
        Browser["Web Browser"]:::external
        ReactSPA["React SPA"]:::frontend
        MainEntry["main.jsx"]:::frontend
        AppComp["App.jsx"]:::frontend
        AuthCtx["AuthContext.jsx"]:::frontend
        APIClient["api.js"]:::frontend
        AuthService["authService.js"]:::frontend
        ProfileService["profileService.js"]:::frontend
        PostService["postService.js"]:::frontend
        ChatService["chatService.js"]:::frontend
        WSClient["websocketService.js"]:::frontend

        Browser -->|"loads"| ReactSPA
        ReactSPA -->|"entrypoint"| MainEntry
        MainEntry -->|"renders"| AppComp
        AppComp -->|"uses"| AuthCtx
        AppComp -->|"calls REST"| APIClient
        APIClient --> AuthService
        APIClient --> ProfileService
        APIClient --> PostService
        APIClient --> ChatService
        AppComp -->|"opens WS"| WSClient
    end

    %% Backend Zone
    subgraph "Backend" 
        direction TB
        DjangoREST["Django REST API"]:::backend
        JWTMiddleware["jjwt_auth_middleware.py"]:::backend
        DjangoChannels["Django Channels"]:::backend
        URLRouter["urls.py"]:::backend
        ASGIEntry["asgi.py / wsgi.py"]:::backend
        Manage["manage.py"]:::backend
        DockerFiles["Dockerfile & docker-compose.yml"]:::backend

        ASGIEntry --> DjangoChannels
        URLRouter --> DjangoREST
        DjangoREST --> JWTMiddleware
        DjangoChannels --> JWTMiddleware
    end

    %% Backend Apps
    subgraph "Django Apps" 
        direction TB
        UsersApp["Users App"]:::backend
        ProfilesApp["Profiles App"]:::backend
        PostsApp["Posts App"]:::backend
        ChatApp["Chat App"]:::backend

        DjangoREST --> UsersApp
        DjangoREST --> ProfilesApp
        DjangoREST --> PostsApp
        DjangoChannels --> ChatApp
    end

    %% Infrastructure
    subgraph "Infrastructure" 
        direction TB
        Database["Postgres/SQLite"]:::infra
        Redis["Redis Broker"]:::infra
        UsersApp -->|ORM| Database
        ProfilesApp -->|ORM| Database
        PostsApp -->|ORM| Database
        ChatApp -->|Pub/Sub| Redis
        DjangoChannels -->|broker| Redis
        DjangoREST -->|ORM| Database
    end

    %% External Connections
    Browser -->|HTTP REST| DjangoREST
    Browser -->|WebSocket| DjangoChannels

    %% Click Events - Frontend
    click ReactSPA "https://github.com/minhduc29/gmu-connect/tree/main/frontend/src"
    click MainEntry "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/main.jsx"
    click AppComp "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/App.jsx"
    click AuthCtx "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/context/AuthContext.jsx"
    click APIClient "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/api.js"
    click AuthService "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/authService.js"
    click ProfileService "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/profileService.js"
    click PostService "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/postService.js"
    click ChatService "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/chatService.js"
    click WSClient "https://github.com/minhduc29/gmu-connect/blob/main/frontend/src/services/websocketService.js"

    %% Click Events - Backend
    click JWTMiddleware "https://github.com/minhduc29/gmu-connect/blob/main/backend/backend/jjwt_auth_middleware.py"
    click URLRouter "https://github.com/minhduc29/gmu-connect/blob/main/backend/backend/urls.py"
    click ASGIEntry "https://github.com/minhduc29/gmu-connect/blob/main/backend/backend/asgi.py"
    click Manage "https://github.com/minhduc29/gmu-connect/blob/main/backend/manage.py"
    click DockerFiles "https://github.com/minhduc29/gmu-connect/blob/main/backend/docker-compose.yml"

    %% Click Events - Django Apps
    click UsersApp "https://github.com/minhduc29/gmu-connect/blob/main/backend/users/models.py"
    click ProfilesApp "https://github.com/minhduc29/gmu-connect/blob/main/backend/profiles/models.py"
    click PostsApp "https://github.com/minhduc29/gmu-connect/blob/main/backend/posts/models.py"
    click ChatApp "https://github.com/minhduc29/gmu-connect/blob/main/backend/chat/consumers.py"

    %% Styles
    classDef frontend fill:#D6E9FF,stroke:#0044CC,color:#000;
    classDef backend fill:#D6F5D6,stroke:#228B22,color:#000;
    classDef infra fill:#F0F0F0,stroke:#666,color:#000;
    classDef external fill:#FFD2D2,stroke:#CC0000,color:#000;
```
