# skip-pay/django-is-core architecture

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

- Interactive diagram: https://gitdiagram.com/skip-pay/django-is-core
- Repository: https://github.com/skip-pay/django-is-core

## Overview

##### Main Components

a. Core Framework Layer
- Forms System (/is_core/forms/)
- Authentication & Permissions (/is_core/auth/)
- Generic Views (/is_core/generic_views/)
- REST Framework (/is_core/rest/)
- Menu System (/is_core/menu/)

b. Extension Components
- DynamoDB Integration (/is_core/contrib/dynamo/)
- Elasticsearch Integration (/is_core/contrib/elasticsearch/)
- Background Export System (/is_core/contrib/background_export/)

c. Frontend Layer
- Static Assets (/is_core/static/)
- Templates (/is_core/templates/)
- UI Components

**┌─ Client Layer ─────────────────────┐**
- Browser UI                       │
- REST API Consumers              │
- ┬───────────────────┘
- ↓
**┌─ Presentation Layer ───────────────┐**
- Generic Views                    │
- Templates                        │
- Forms                           │
- ┬───────────────────┘
- ↓
**┌─ Core Framework Layer ─────────────┐**
- Authentication                   │
- Permissions                      │
- REST Resources                   │
- Menu System                      │
- ┬───────────────────┘
- ↓
**┌─ Storage Layer ───────────────────┐**
- Django Models                    │
- DynamoDB                        │
- Elasticsearch                   │
- ┘

##### Important Relationships

a. Data Flow
- How requests flow from client through generic views to REST resources
- How forms interact with models and validation
- How background export process works

b. Integration Points
- How DynamoDB and Elasticsearch integrate with core components
- Authentication flow
- Permission checking points

##### Implementation Details

- Rectangles for core modules
- Hexagons for interfaces
- Rounded rectangles for services

Annotations for key features:
- Automatic form generation
- REST resource generation
- Permission checking points
- Export capabilities

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef client fill:#FFA07A,stroke:#333,stroke-width:2px
    classDef presentation fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef core fill:#4169E1,stroke:#333,stroke-width:2px
    classDef storage fill:#90EE90,stroke:#333,stroke-width:2px
    classDef infrastructure fill:#D3D3D3,stroke:#333,stroke-width:2px

    %% Client Layer
    subgraph ClientLayer
        Browser["Browser UI"]
        APIConsumers["REST API Consumers"]
    end
    class Browser,APIConsumers client

    %% Presentation Layer
    subgraph PresentationLayer
        GenericViews["Generic Views"]
        Templates["Templates"]
        Forms["Forms System"]
        UIComponents["UI Components"]
    end
    class GenericViews,Templates,Forms,UIComponents presentation

    %% Core Framework Layer
    subgraph CoreLayer
        Auth["Authentication & Permissions"]
        REST["REST Framework"]
        Menu["Menu System"]
    end
    class Auth,REST,Menu core

    %% Storage Layer
    subgraph StorageLayer
        Models[(Django Models)]
        DynamoDB[(DynamoDB)]
        Elastic[(Elasticsearch)]
        Export["Background Export"]
    end
    class Models,DynamoDB,Elastic,Export storage

    %% Relationships
    Browser --> GenericViews
    APIConsumers --> REST
    GenericViews --> Forms
    GenericViews --> Templates
    Forms --> REST
    REST --> Auth
    Auth --> Models
    REST --> Models
    Menu --> Templates
    Models --> DynamoDB
    Models --> Elastic
    Models --> Export

    %% Click Events
    click Forms "https://github.com/skip-pay/django-is-core/tree/master/is_core/forms/"
    click Auth "https://github.com/skip-pay/django-is-core/tree/master/is_core/auth/"
    click GenericViews "https://github.com/skip-pay/django-is-core/tree/master/is_core/generic_views/"
    click REST "https://github.com/skip-pay/django-is-core/tree/master/is_core/rest/"
    click Menu "https://github.com/skip-pay/django-is-core/blob/master/is_core/menu.py"
    click DynamoDB "https://github.com/skip-pay/django-is-core/tree/master/is_core/contrib/dynamo/"
    click Elastic "https://github.com/skip-pay/django-is-core/tree/master/is_core/contrib/elasticsearch/"
    click Export "https://github.com/skip-pay/django-is-core/tree/master/is_core/contrib/background_export/"
    click Templates "https://github.com/skip-pay/django-is-core/tree/master/is_core/templates/is_core/"
    click UIComponents "https://github.com/skip-pay/django-is-core/blob/master/is_core/static/is_core/js/app.js"

    %% Legend
    subgraph Legend
        Client["Client Components"]:::client
        Present["Presentation Components"]:::presentation
        CoreComp["Core Components"]:::core
        Store["Storage Components"]:::storage
    end
```
