# durjoykumar177/tuitionvault architecture

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

- Interactive diagram: https://gitdiagram.com/durjoykumar177/tuitionvault
- Repository: https://github.com/durjoykumar177/tuitionvault

## Overview

##### Project Type and Purpose
- This is a Django REST Framework (DRF) backend service for the TuitionsVault full-stack web application.
- Its primary responsibility is to expose a set of RESTful endpoints for user authentication, tuition post management, application tracking, and a review system.

##### Main Components
- API Gateway / Load Balancer (if used in production)
- Django Application Server (TuitionVault project) broken into four Django “apps”:
- accounts (authentication, user profiles, password reset & email confirmation)
- tutions (tuition listing, filtering, search, apply)
- applications (view pending/approved/archived applications)
- reviews (submit/view reviews)
- Django Admin Interface
- Database (PostgreSQL in prod, SQLite in dev)
- Email/SMTP Service (for confirmation & reset emails)
- Static/File Storage (local filesystem or S3 for user photos and tuition images)
- (Optional) Caching Layer or Message Broker if planning async tasks

##### Relationships and Data Flows
- External Client (Web or Mobile) → HTTP/HTTPS → Load Balancer → Django REST Framework
- DRF endpoints are namespaced by app (e.g., /accounts/, /tutions/, /applications/, /reviews/)
- Each view or serializer invokes Django ORM, which issues SQL queries to the database
- For email-related actions, DRF triggers Django’s Email Backend → SMTP provider
- File uploads/downloads flow between Django and file storage (local or cloud)
- Admin users access the Django Admin UI directly on the application server

##### Architectural Patterns and Design Principles
- Layered Architecture (Views → Serializers → Models → Database)
- Modular “Django App” decomposition by domain
- Stateless JWT Authentication for API requests
- Use of Django’s built-in URL routing to map endpoints to viewsets/functions
- Separation of concerns: business logic in views/serializers, data in models

##### Technologies and Frameworks to Annotate
- Django & Django REST Framework
- Python 3.x
- PostgreSQL (primary), SQLite (development)
- JWT for token-based auth
- Django ORM for database interaction
- SMTP or third-party email service (Mailgun, SendGrid)
- (Optional) Redis/Celery for background tasks
- Web Server (Gunicorn/Uvicorn) and WSGI/ASGI Interfaces

##### Step-by-Step for the Engineer
1. Sketch the client side (browser or mobile) at the top.
7. JWT auth flow: client → login endpoint → token issuance → subsequent calls bear token.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Client
    Client["Web/Mobile Client"]:::external

    %% Load Balancer
    LB["API Gateway / Load Balancer"]:::backend

    Client -->|"HTTP/HTTPS"| LB

    %% Django Application Server
    subgraph "Django Application Server" 
        direction TB
        %% Authentication App
        subgraph "Accounts App" 
            direction TB
            AA_models["accounts/models.py"]:::backend
            AA_views["accounts/views.py"]:::backend
            AA_serializers["accounts/serializers.py"]:::backend
            AA_urls["accounts/urls.py"]:::backend
            AA_admin["accounts/admin.py"]:::backend
            AA_templates["accounts/templates/*.html"]:::backend
            AA_migrations["accounts/migrations/"]:::backend
        end

        %% Tuitions App
        subgraph "Tuitions App" 
            direction TB
            TU_models["tutions/models.py"]:::backend
            TU_views["tutions/views.py"]:::backend
            TU_serializers["tutions/serializers.py"]:::backend
            TU_urls["tutions/urls.py"]:::backend
            TU_admin["tutions/admin.py"]:::backend
            TU_templates["tutions/templates/applyNotification.html"]:::backend
            TU_images["tutions/images/"]:::storage
            TU_migrations["tutions/migrations/"]:::backend
        end

        %% Applications App
        subgraph "Applications App" 
            direction TB
            AP_models["applications/models.py"]:::backend
            AP_views["applications/views.py"]:::backend
            AP_serializers["applications/serializers.py"]:::backend
            AP_urls["applications/urls.py"]:::backend
            AP_admin["applications/admin.py"]:::backend
            AP_migrations["applications/migrations/"]:::backend
        end

        %% Reviews App
        subgraph "Reviews App" 
            direction TB
            RV_models["reviews/models.py"]:::backend
            RV_views["reviews/views.py"]:::backend
            RV_serializers["reviews/serializers.py"]:::backend
            RV_urls["reviews/urls.py"]:::backend
            RV_admin["reviews/admin.py"]:::backend
            RV_migrations["reviews/migrations/"]:::backend
        end

        %% Project Config & Entry
        subgraph "Project Config & Entry"
            direction TB
            PV_settings["TuitionVault/settings.py"]:::backend
            PV_urls["TuitionVault/urls.py"]:::backend
            PV_asgi["TuitionVault/asgi.py"]:::backend
            PV_wsgi["TuitionVault/wsgi.py"]:::backend
            manage["manage.py"]:::backend
            reqs["requirements.txt"]:::backend
        end
    end

    LB -->|"Routes to DRF"| AA_urls
    LB --> TU_urls
    LB --> AP_urls
    LB --> RV_urls

    %% Database
    DB["PostgreSQL / SQLite"]:::db
    AA_models -->|ORM Queries| DB
    TU_models --> DB
    AP_models --> DB
    RV_models --> DB
    PV_settings --> DB

    %% File Storage
    FS["File Storage (Local/S3)"]:::storage
    TU_images --> FS
    AA_templates --> FS

    %% Email Service
    Email["SMTP / Email Service"]:::external
    AA_views -->|send email| Email
    TU_views -->|send notification| Email

    %% Admin Interface
    AdminUI["Django Admin Interface"]:::backend
    AdminUI --> AA_admin
    AdminUI --> TU_admin
    AdminUI --> AP_admin
    AdminUI --> RV_admin
    LB -->|"Admin Access"| AdminUI

    %% Legend and Auth Flow (annotated)
    Client -->|"Login / JWT"| AA_urls
    AA_views -->|"Issue Token"| Client
    Client -->|"JWT Auth"| LB

    %% Click Events
    click AA_models "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/models.py"
    click AA_views "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/views.py"
    click AA_serializers "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/serializers.py"
    click AA_urls "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/urls.py"
    click AA_admin "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/admin.py"
    click AA_templates "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/templates/confirm_email.html"
    click AA_templates "https://github.com/durjoykumar177/tuitionvault/blob/main/accounts/templates/password_reset_email.html"
    click AA_migrations "https://github.com/durjoykumar177/tuitionvault/tree/main/accounts/migrations/"

    click TU_models "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/models.py"
    click TU_views "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/views.py"
    click TU_serializers "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/serializers.py"
    click TU_urls "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/urls.py"
    click TU_admin "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/admin.py"
    click TU_templates "https://github.com/durjoykumar177/tuitionvault/blob/main/tutions/templates/applyNotification.html"
    click TU_images "https://github.com/durjoykumar177/tuitionvault/tree/main/tutions/images/"
    click TU_migrations "https://github.com/durjoykumar177/tuitionvault/tree/main/tutions/migrations/"

    click AP_models "https://github.com/durjoykumar177/tuitionvault/blob/main/applications/models.py"
    click AP_views "https://github.com/durjoykumar177/tuitionvault/blob/main/applications/views.py"
    click AP_serializers "https://github.com/durjoykumar177/tuitionvault/blob/main/applications/serializers.py"
    click AP_urls "https://github.com/durjoykumar177/tuitionvault/blob/main/applications/urls.py"
    click AP_admin "https://github.com/durjoykumar177/tuitionvault/blob/main/applications/admin.py"
    click AP_migrations "https://github.com/durjoykumar177/tuitionvault/tree/main/applications/migrations/"

    click RV_models "https://github.com/durjoykumar177/tuitionvault/blob/main/reviews/models.py"
    click RV_views "https://github.com/durjoykumar177/tuitionvault/blob/main/reviews/views.py"
    click RV_serializers "https://github.com/durjoykumar177/tuitionvault/blob/main/reviews/serializers.py"
    click RV_urls "https://github.com/durjoykumar177/tuitionvault/blob/main/reviews/urls.py"
    click RV_admin "https://github.com/durjoykumar177/tuitionvault/blob/main/reviews/admin.py"
    click RV_migrations "https://github.com/durjoykumar177/tuitionvault/tree/main/reviews/migrations/"

    click PV_settings "https://github.com/durjoykumar177/tuitionvault/blob/main/TuitionVault/settings.py"
    click PV_urls "https://github.com/durjoykumar177/tuitionvault/blob/main/TuitionVault/urls.py"
    click PV_asgi "https://github.com/durjoykumar177/tuitionvault/blob/main/TuitionVault/asgi.py"
    click PV_wsgi "https://github.com/durjoykumar177/tuitionvault/blob/main/TuitionVault/wsgi.py"
    click manage "https://github.com/durjoykumar177/tuitionvault/blob/main/manage.py"
    click reqs "https://github.com/durjoykumar177/tuitionvault/blob/main/requirements.txt"

    classDef backend fill:#D0E8FF,stroke:#0366d6,color:#0366d6
    classDef db fill:#E0F8E0,stroke:#2E7D32,color:#2E7D32
    classDef storage fill:#E8F5E9,stroke:#2E7D32,color:#2E7D32
    classDef external fill:#FFF3E0,stroke:#FB8C00,color:#FB8C00
```
