# parkermedlin/kpk-app architecture

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

- Interactive diagram: https://gitdiagram.com/parkermedlin/kpk-app
- Repository: https://github.com/parkermedlin/kpk-app

## Overview

##### Project type and purpose
- This is a monolithic, full-stack Django web application (“Blendverse”) extended with auxiliary Python scripts for ETL, reporting, and local-machine utilities.
- Purpose: Replace spreadsheet/ERP interfaces in the chemical blending department with a unified web portal for MRP, inventory tracking, production analysis, safety checklists, and reporting.

##### File structure
- Top-level directories:
- `app/` – Django project root, contains:
– `app/` (project module: settings.py, asgi.py, wsgi.py, custom middleware, URL routing)
– `core/`, `prodverse/`, `nav3d/`, `kpklauncher/` – separate Django “apps” each handling a feature domain
– `templates/` and static assets under each app for frontend
– `manage.py`
- `docker-compose-*.yml`, `Dockerfile`, `nginx/` – containerization and reverse-proxy configuration
- `local_machine_scripts/` – standalone Python/batch/PowerShell scripts for data import, backups, ETL
- `db_backups/`, `whls/` – artifacts and binary wheels
- Key patterns:
- MVC (Django’s MTV)
- Asynchronous tasks via Celery management commands
- WebSockets (Django Channels in `core/consumers.py` & ASGI)
- Static files served by NGINX (CSS/JS under each app’s `static/`)
- External integrations: Sage 100 via pyodbc, SMTP for emails, 3D viewer in `nav3d`

##### README for insights
- Primary modules live: forklift safety checklists, lot-number records, MRP updates, blend scheduling, issue-sheet generation
- Under-development modules: digital blend sheets, blend inventory counts
- Tech stack: Python 3.9, Django, Bootstrap 5, jQuery 3.6.0, PostgreSQL 13, pyodbc (Sage 100), Celery, Docker, NGINX
- On-premises deployment, uses CSV fallbacks

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients Layer
    subgraph "Clients" 
        Browser["Browser"]:::frontend
        Tablet["Tablet / Forklift UI"]:::frontend
    end

    %% Reverse Proxy
    Browser -->|HTTP/WebSocket| NGINX["NGINX Reverse Proxy"]:::app
    Tablet -->|HTTP/WebSocket| NGINX

    %% Application Servers
    NGINX --> ASGI["ASGI Server"]:::app
    NGINX --> WSGI["WSGI Server"]:::app
    click ASGI "https://github.com/parkermedlin/kpk-app/blob/main/app/app/asgi.py"
    click WSGI "https://github.com/parkermedlin/kpk-app/blob/main/app/app/wsgi.py"

    %% Django Monolith
    subgraph "Django Monolith"
        subgraph "Project Configuration"
            ProjectModule["app (module)"]:::config
            Settings["settings.py"]:::config
            URLs["urls.py"]:::config
            Middleware["customMiddleware.py"]:::config
        end
        subgraph "Applications"
            %% Core App
            subgraph "Core App"
                CC["consumers.py"] 
                Models["models.py"]
                Serializers["serializers.py"]
                Tasks["taskfunctions.py"]
                Mgmt["management/commands"]
                CoreTemplates["templates & static"]
            end
            click ProjectModule "https://github.com/parkermedlin/kpk-app/tree/main/app/app"
            click Settings "https://github.com/parkermedlin/kpk-app/blob/main/app/app/settings.py"
            click URLs "https://github.com/parkermedlin/kpk-app/blob/main/app/app/urls.py"
            click Middleware "https://github.com/parkermedlin/kpk-app/blob/main/app/app/customMiddleware.py"
            click CC "https://github.com/parkermedlin/kpk-app/blob/main/app/core/consumers.py"
            click Models "https://github.com/parkermedlin/kpk-app/blob/main/app/core/models.py"
            click Serializers "https://github.com/parkermedlin/kpk-app/blob/main/app/core/serializers.py"
            click Tasks "https://github.com/parkermedlin/kpk-app/blob/main/app/core/taskfunctions.py"
            click Mgmt "https://github.com/parkermedlin/kpk-app/tree/main/app/core/management/commands"
            click CoreTemplates "https://github.com/parkermedlin/kpk-app/tree/main/app/core/templates"
            %% Prodverse App
            subgraph "Prodverse App"
                PConsumers["consumers.py"]
                PModels["models.py"]
                PViews["views.py"]
                Forms["forms.py"]
                PTemplates["templates & static"]
                PUrls["urls.py"]
            end
            click PConsumers "https://github.com/parkermedlin/kpk-app/blob/main/app/prodverse/consumers.py"
            click PModels "https://github.com/parkermedlin/kpk-app/blob/main/app/prodverse/models.py"
            click PViews "https://github.com/parkermedlin/kpk-app/blob/main/app/prodverse/views.py"
            click Forms "https://github.com/parkermedlin/kpk-app/blob/main/app/prodverse/forms.py"
            click PTemplates "https://github.com/parkermedlin/kpk-app/tree/main/app/prodverse/templates"
            click PUrls "https://github.com/parkermedlin/kpk-app/blob/main/app/prodverse/urls.py"
            %% Nav3D App
            subgraph "Nav3D App"
                NavView["views.py"]
                NavUrls["urls.py"]
                Interface["interface.html"]
                Modules["static/nav3d/js/modules"]
            end
            click NavView "https://github.com/parkermedlin/kpk-app/blob/main/app/nav3d/views.py"
            click NavUrls "https://github.com/parkermedlin/kpk-app/blob/main/app/nav3d/urls.py"
            click Interface "https://github.com/parkermedlin/kpk-app/blob/main/app/nav3d/templates/nav3d/interface.html"
            click Modules "https://github.com/parkermedlin/kpk-app/tree/main/app/nav3d/static/nav3d/js/modules"
            %% KPKLauncher App
            subgraph "KPKLauncher App"
                KView["views.py"]
                KTemplate["launcher.html"]
                KStatic["static/kpklauncher"]
                Manifest["manifest.xml"]
                KUrls["urls.py"]
            end
            click KView "https://github.com/parkermedlin/kpk-app/blob/main/app/kpklauncher/views.py"
            click KTemplate "https://github.com/parkermedlin/kpk-app/blob/main/app/kpklauncher/templates/kpklauncher/launcher.html"
            click KStatic "https://github.com/parkermedlin/kpk-app/tree/main/app/kpklauncher/static/kpklauncher"
            click Manifest "https://github.com/parkermedlin/kpk-app/blob/main/app/kpklauncher/o365addins/excelitemlookup/manifest.xml"
            click KUrls "https://github.com/parkermedlin/kpk-app/blob/main/app/kpklauncher/urls.py"
        end
    end

    %% Task & Messaging Layer
    DjangoWorker["Celery Workers"]:::app
    ASGI --> DjangoWorker
    WSGI --> DjangoWorker

    %% Data & Broker Layer
    DjangoWorker --> Redis["Redis Broker"]:::data
    Redis --> DjangoWorker
    DjangoWorker --> Postgres["PostgreSQL Database"]:::data

    %% External Integrations
    DjangoWorker -->|ODBC| Sage100["Sage100 ERP"]:::external
    DjangoWorker -->|SMTP| SMTP["SMTP Server"]:::external
    DjangoWorker -->|File/CSV| FileShare["File Share / CSV"]:::external

    %% Local Scripts
    subgraph "Local ETL & Backup Scripts"
        LocalScripts["Scripts & Utilities"]:::tool
    end
    LocalScripts -->|DB/API| Postgres
    LocalScripts -->|DB/API| DjangoWorker
    click LocalScripts "https://github.com/parkermedlin/kpk-app/tree/main/local_machine_scripts"

    %% Containerization
    subgraph "Containerization"
        DockerfileN["Dockerfile"] 
        Compose["docker-compose-*.yml"]
        NginxConf["nginx/nginx.conf"]
    end
    click DockerfileN "https://github.com/parkermedlin/kpk-app/tree/main/Dockerfile"
    click Compose "https://github.com/parkermedlin/kpk-app/blob/main/docker-compose-DEV.yml"
    click NginxConf "https://github.com/parkermedlin/kpk-app/blob/main/nginx/nginx.conf"

    %% Styles
    classDef frontend fill:#b3cde0,stroke:#000,stroke-width:1px
    classDef app fill:#ccebc5,stroke:#000,stroke-width:1px
    classDef data fill:#fed9a6,stroke:#000,stroke-width:1px
    classDef external fill:#f2f0f7,stroke:#000,stroke-width:1px
    classDef config fill:#d9d9d9,stroke:#000,stroke-width:1px
    classDef tool fill:#e5e5e5,stroke:#000,stroke-width:1px
```
