# bguerradev/smspy architecture

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

- Interactive diagram: https://gitdiagram.com/bguerradev/smspy
- Repository: https://github.com/bguerradev/smspy

## Overview

##### Project Type and Purpose
- SMSPy is a **full‐stack web messaging system**.
- Purpose: user registration/authentication, sending/receiving messages (with images), user profiles, global toast notifications.

##### File Structure
- **Backend** (`user_messages_backend/`):
- Django project (“core” settings, URLs, ASGI/WGI)
- Django app `user_messages` (models, serializers, views, URLs, migrations)
- JWT auth via Django REST Framework
- `requirements.txt`, `render.yaml` (deployment config), SQLite (dev)
- **Frontend** (`user_messages_frontend/`):
- React SPA bootstrapped with Vite (`vite.config.js`)
- Components folder (`MessageList`, `MessageForm`, `Login`, `Register`, etc.)
- Services (`api.js` for REST calls, toast manager helper)
- Styling (`CSS`, Bootstrap)
- `package.json`, `public/index.html`

##### Key Insights from README
- Backend: Python, Django, DRF, JWT
- Frontend: React, Bootstrap
- Uses SQLite in dev; plans for PostgreSQL
- Features: auth, messaging with image upload, user avatars, global toasts

##### Main Components
a. **Client (Browser/React SPA)**
- Components: Login/Register, MessageTabs, MessageList, MessageForm, Profile, ToastManager
- JWT storage (in memory or localStorage)
- HTTP client (`api.js`)
b. **API Layer (Django REST Framework)**
- Endpoints: `/api/auth/`, `/api/messages/`, `/api/users/`
- JWT authentication middleware
- Views/Serializers
c. **Database**
- Future: PostgreSQL
d. **Media Storage**
- Local filesystem (dev) or S3/Cloud (prod) for uploaded images and avatars
e. **Deployment/Infrastructure**
- Render (as specified in `render.yaml`) or other cloud
- Web server (Gunicorn/Uvicorn), reverse proxy (nginx)

##### Relationships & Data Flow
- Browser → API: REST calls with JWT in Authorization header
- API → DB: ORM queries (read/write messages, users)
- API ↔ Media Store: save/fetch images
- Browser: receives JSON → React state → UI
- ToastManager: listens for API responses → displays notifications

##### Architectural Patterns & Principles
- **Separation of Concerns**: clear split between SPA and REST API
- **Stateless Authentication**: JWT tokens, no server‐side sessions
- **MVC (Django)**: models, views, serializers (acts as “controllers”)
- **Component-Based UI**: React functional components

##### Technologies & Frameworks
- Python, Django, Django REST Framework, djangorestframework-simplejwt
- React, Vite, JSX, Bootstrap/CSS
- SQLite (dev), PostgreSQL (future)
- Render.com (deploy), Docker (optional)

##### Putting It All Together
- Inside API, note the `core` module (settings, URLs), `user_messages` app (models, serializers, views)

## Diagram (Mermaid)

```mermaid
graph TB
    %% External
    User["User's Browser"]:::external

    %% Frontend Layer
    subgraph "Frontend Layer"
        ReactSPA["React SPA"]:::frontend
        Login["Login Component"]:::frontend
        Register["Register Component"]:::frontend
        MessageTabs["MessageTabs Component"]:::frontend
        MessageList["MessageList Component"]:::frontend
        MessageForm["MessageForm Component"]:::frontend
        Profile["Profile Component"]:::frontend
        ToastManager["ToastManager Component"]:::frontend
        ProtectedRoute["ProtectedRoute Component"]:::frontend
        ApiService["HTTP Client Service (api.js)"]:::frontend
        ToastHelper["Toast Helper Service"]:::frontend
        EntryPoint["React Entry Point (main.jsx)"]:::frontend
        ViteConfig["Vite Configuration"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        API["Django REST API"]:::backend
        subgraph "Core Module"
            Core["Core (settings, URLs, ASGI/WGI)"]:::backend
        end
        subgraph "User Messages App"
            Models["Models"]:::backend
            Serializers["Serializers"]:::backend
            Views["Views"]:::backend
            Urls["URL Routes"]:::backend
            Admin["Admin Registration"]:::backend
            AppsConf["App Configuration"]:::backend
            Tests["Tests"]:::backend
            Migrations["Migrations"]:::backend
        end
    end

    %% Data Storage
    DB["SQLite Database"]:::data
    Media["Media Storage"]:::data

    %% Connections
    User -->|"HTTP/HTTPS + JWT"| ReactSPA
    ReactSPA -->|"REST Calls"| API
    API -->|"ORM read/write"| DB
    API -->|"Upload/Download"| Media

    %% Click Events Frontend
    click ReactSPA "https://github.com/bguerradev/smspy/tree/main/user_messages_frontend/"
    click Login "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/Login.jsx"
    click Register "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/Register.jsx"
    click MessageTabs "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/MessageTabs.jsx"
    click MessageList "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/MessageList.jsx"
    click MessageForm "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/MessageForm.jsx"
    click Profile "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/Profile.jsx"
    click ToastManager "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/ToastManager.jsx"
    click ProtectedRoute "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/components/ProtectedRoute.jsx"
    click ApiService "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/services/api.js"
    click ToastHelper "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/services/getExportToastManager.js"
    click EntryPoint "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/src/main.jsx"
    click ViteConfig "https://github.com/bguerradev/smspy/blob/main/user_messages_frontend/vite.config.js"

    %% Click Events Backend
    click Core "https://github.com/bguerradev/smspy/tree/main/user_messages_backend/core/"
    click Core "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/core/settings.py"
    click Core "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/core/urls.py"
    click Core "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/core/asgi.py"
    click Core "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/core/wsgi.py"
    click Models "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/models.py"
    click Serializers "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/serializers.py"
    click Views "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/views.py"
    click Urls "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/urls.py"
    click Admin "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/admin.py"
    click AppsConf "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/apps.py"
    click Tests "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/user_messages/tests.py"
    click Migrations "https://github.com/bguerradev/smspy/tree/main/user_messages_backend/user_messages/migrations/"
    click API "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/manage.py"
    click API "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/render.yaml"
    click API "https://github.com/bguerradev/smspy/blob/main/user_messages_backend/requirements.txt"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#0288D1,stroke-width:1px
    classDef backend fill:#E8F5E9,stroke:#2E7D32,stroke-width:1px
    classDef data fill:#FFE0B2,stroke:#EF6C00,stroke-width:1px
    classDef external fill:#CFD8DC,stroke:#546E7A,stroke-width:1px
```
