# dhruvsharma-05/cafetrends architecture

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

- Interactive diagram: https://gitdiagram.com/dhruvsharma-05/cafetrends
- Repository: https://github.com/dhruvsharma-05/cafetrends

## Overview

##### Project type and purpose
- CafeTrends is a data-analytics dashboard application (a single‐page “full-stack” web app) built with Streamlit. Its purpose is to ingest college canteen transaction data, compute RFM metrics, segment customers via K-Means, and deliver interactive visualizations and business insights.

##### File structure
Root directory
- 07RetailIndustryAnalytics.pdf – research inspiration
- Analysis.ipynb – exploratory analysis notebook
- app.py – main Streamlit application (entry point)
- requirements.txt – Python dependencies
- README.md – project overview, tech stack, instructions
Data folder
- CSV files (monthly/aggregate transactions)
- Stock items.xlsx – catalog of stock codes

Key points
- app.py drives the UI, data loading, processing, clustering, and visualization.
- Python modules (Pandas, Scikit-learn, Plotly) supply data-science and charting capabilities.
- All data is file-based under /Data. No external databases or microservices.

##### README for additional insights
- Tech stack: Streamlit (UI), Pandas (ETL), Scikit-learn (ML), Plotly (Viz), K-Means (clustering).
- Features: RFM segmentation, 3D interactive plots, lifetime value prediction, revenue stream analysis.
- Deployment: run locally via `streamlit run app.py`.

a. Main components
1. Client Browser / Streamlit Frontend
2. Streamlit Application Server (app.py)
3. Data Loader & Preprocessor (Pandas)
4. ML Engine (Scikit-learn + K-Means clustering)
5. Visualization Module (Plotly charts)
6. Data Storage (local CSV / XLSX files)
b. Relationships & interactions
– Browser ↔ Streamlit server: user inputs (date ranges, filters) → app.py
– app.py loads raw files from Data/ → passes to Pandas
– Preprocessed data → fed into ML Engine → segmentation results
– app.py consolidates results → Plotly produces interactive figures
– Streamlit serves charts & tables back to Browser
c. Architectural patterns / design principles
– Monolithic, layered design (UI layer, business logic layer, data layer)
– MVC-like separation:
- Model = data files + Pandas DataFrames + cluster labels
- View = Streamlit UI + Plotly outputs
- Controller = app.py coordinating workflow
– Reusability: Analysis.ipynb acts as exploratory sandbox, app.py is production code
d. Technologies / frameworks
– Python 3.8+
– Streamlit (UI framework)
– Pandas (data ETL)
– Scikit-learn (RFM computation, K-Means)
– Plotly (2D/3D interactive visualizations)

##### Final advice
- Steps—even intermediate ones like RFM feature calculation.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External References
    subgraph "External References"
        direction TB
        PDF["07RetailIndustryAnalytics.pdf"]:::external
        Notebook["Analysis.ipynb"]:::external
        README["README.md"]:::external
        Req["requirements.txt"]:::external
    end

    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Browser["Client Browser / Streamlit UI"]:::ui
        Streamlit["Streamlit App Controller (app.py)"]:::ui
    end

    %% Business Logic Layer
    subgraph "Business Logic Layer"
        direction TB
        Loader["Data Loader & Preprocessor (Pandas)"]:::logic
        ML["ML Engine (Scikit-learn K-Means, RFM)"]:::logic
        Viz["Visualization Module (Plotly)"]:::logic
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        DataDir["Data Storage (local files)"]:::data
        CSV1["January_2024_Transactions.csv"]:::data
        CSV2["Feb_Mar_Apr_2024_Transactions.csv"]:::data
        CSV3["Final_Transactions.csv"]:::data
        XLSX["Stock items.xlsx"]:::data
    end

    %% Connections
    Browser -->|"user inputs/events"| Streamlit
    Streamlit -->|"load files"| Loader
    Loader -->|"clean & feature engineering"| ML
    ML -->|"segmentation results"| Viz
    Viz -->|"charts & tables"| Streamlit
    Streamlit -->|"render UI"| Browser

    DataDir --> CSV1
    DataDir --> CSV2
    DataDir --> CSV3
    DataDir --> XLSX
    CSV1 --> Loader
    CSV2 --> Loader
    CSV3 --> Loader
    XLSX --> Loader

    %% Click Events
    click Browser "https://github.com/dhruvsharma-05/cafetrends/blob/main/app.py"
    click Streamlit "https://github.com/dhruvsharma-05/cafetrends/blob/main/app.py"
    click Loader "https://github.com/dhruvsharma-05/cafetrends/blob/main/app.py"
    click ML "https://github.com/dhruvsharma-05/cafetrends/blob/main/app.py"
    click Viz "https://github.com/dhruvsharma-05/cafetrends/blob/main/app.py"
    click DataDir "https://github.com/dhruvsharma-05/cafetrends/tree/main/Data/"
    click CSV1 "https://github.com/dhruvsharma-05/cafetrends/blob/main/Data/January_2024_Transactions.csv"
    click CSV2 "https://github.com/dhruvsharma-05/cafetrends/blob/main/Data/Feb_Mar_Apr_2024_Transactions.csv"
    click CSV3 "https://github.com/dhruvsharma-05/cafetrends/blob/main/Data/Final_Transactions.csv"
    click XLSX "https://github.com/dhruvsharma-05/cafetrends/blob/main/Data/Stock items.xlsx"
    click Notebook "https://github.com/dhruvsharma-05/cafetrends/blob/main/Analysis.ipynb"
    click PDF "https://github.com/dhruvsharma-05/cafetrends/blob/main/07RetailIndustryAnalytics.pdf"
    click README "https://github.com/dhruvsharma-05/cafetrends/blob/main/README.md"
    click Req "https://github.com/dhruvsharma-05/cafetrends/blob/main/requirements.txt"

    %% Styles
    classDef ui fill:#D0E1FF,stroke:#0366d6,color:#0366d6
    classDef logic fill:#DFFFE0,stroke:#28A745,color:#28A745
    classDef data fill:#FFEFD0,stroke:#e36209,color:#e36209
    classDef external fill:#F0F0F0,stroke:#888,color:#888
```
