# aksharahegde/django-jet-3-calm architecture

> Architecture diagram of the GitHub repository aksharahegde/django-jet-3-calm, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aksharahegde/django-jet-3-calm
- Repository: https://github.com/aksharahegde/django-jet-3-calm

## Overview

a. Django Integration:
- Django Admin <---> JET Core <---> Dashboard
- ↑

- Middleware

b. External Services:
- Google Analytics API <---> Dashboard Modules

##### Key Subsystems (Use nested containers)

a. Static Asset Pipeline:
- SCSS/CSS Files --> Compilation --> Themed CSS
- JS Sources --> Bundling --> Production JS

b. Dashboard Components:
- Module Registry --> Module Rendering --> User Dashboard

- User Request --> URL Router --> View Handler --> Template Renderer --> Response

##### Component Details

a. Core Features:
- Template Override System
- Admin View Customization
- URL Routing
- Permission Management

b. Dashboard Features:
- Module Management
- Widget System
- Analytics Integration
- Customization API

##### Technical Elements

- Template inheritance hierarchy
- Static asset compilation flow
- Internationalization points
- Extension points

##### Modularity
- Clear separation between core and dashboard
- Plugin points for custom modules

##### Integration Points
- Django Admin integration
- External service connections
- Custom module hooks

##### Asset Management
- Theme compilation pipeline
- Static file serving
- Resource optimization

##### Security Layer
- Authentication flow
- Permission checks
- Admin access controls

##### Dashboard customization flow

Remember to maintain a balance between detail and clarity, focusing on the architectural elements that are most important for understanding the system's structure and behavior.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core
        JC[JET Core]:::core
        DM[Dashboard Module]:::dashboard
        AII[Admin Interface Integration]:::admin
        SAM[Static Assets Manager]:::assets
    end

    subgraph Features
        TS[Theme System]:::theme
        AL[Authentication Layer]:::auth
        I18N[Internationalization]:::i18n
        FS[Filter System]:::filter
        WS[Widget System]:::widget
    end

    subgraph Integration
        DA[Django Admin]:::django
        GAI[Google Analytics API]:::external
    end

    subgraph "Asset Pipeline"
        SCSS["SCSS/CSS Files"]:::asset
        JS["JS Sources"]:::asset
        TC["Themed CSS"]:::asset
        PJS["Production JS"]:::asset
        SCSS --> TC
        JS --> PJS
    end

    subgraph "Dashboard Components"
        MR["Module Registry"]:::dashboard
        MRD["Module Rendering"]:::dashboard
        UD["User Dashboard"]:::dashboard
        MR --> MRD --> UD
    end

    %% Core Connections
    DA <--> JC
    JC <--> DM
    JC --> AII
    SAM --> AII

    %% Feature Connections
    JC --> TS
    JC --> AL
    JC --> I18N
    JC --> FS
    JC --> WS

    %% Integration Connections
    GAI <--> DM
    
    %% Asset Connections
    SAM --> SCSS
    SAM --> JS

    %% Dashboard Flow
    DM --> MR

    %% Click Events
    click JC "https://github.com/aksharahegde/django-jet-3-calm/blob/main/jet/__init__.py"
    click DM "https://github.com/aksharahegde/django-jet-3-calm/tree/main/jet/dashboard/"
    click AII "https://github.com/aksharahegde/django-jet-3-calm/tree/main/jet/templates/admin/"
    click SAM "https://github.com/aksharahegde/django-jet-3-calm/tree/main/jet/static/jet/"
    click TS "https://github.com/aksharahegde/django-jet-3-calm/tree/main/jet/static/jet/css/themes/"
    click I18N "https://github.com/aksharahegde/django-jet-3-calm/tree/main/jet/locale/"
    click FS "https://github.com/aksharahegde/django-jet-3-calm/blob/main/jet/filters.py"
    click WS "https://github.com/aksharahegde/django-jet-3-calm/blob/main/jet/static/admin/css/widgets.css"
    click GAI "https://github.com/aksharahegde/django-jet-3-calm/blob/main/jet/dashboard/dashboard_modules/google_analytics.py"
    click MR "https://github.com/aksharahegde/django-jet-3-calm/blob/main/jet/dashboard/modules.py"

    %% Styling
    classDef core fill:#2b5797,color:white
    classDef dashboard fill:#e67e22,color:white
    classDef admin fill:#16a085,color:white
    classDef assets fill:#8e44ad,color:white
    classDef theme fill:#2ecc71,color:white
    classDef auth fill:#e74c3c,color:white
    classDef i18n fill:#f1c40f,color:white
    classDef filter fill:#95a5a6,color:white
    classDef widget fill:#3498db,color:white
    classDef django fill:#34495e,color:white
    classDef external fill:#7f8c8d,color:white
    classDef asset fill:#bdc3c7,color:black
```
