# aakinolaj/reviewers-dashboard architecture

> Architecture diagram of the GitHub repository aakinolaj/reviewers-dashboard, 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/aakinolaj/reviewers-dashboard
- Repository: https://github.com/aakinolaj/reviewers-dashboard

## Overview

##### Project type and purpose
- This is a single-page NLP dashboard built on Streamlit (a Python web-app framework).

##### File structure
- Root:
– luxor_dashboard_app.py → the main Streamlit application
– luxor_reviews_only.csv → sample data
– requirements.txt → dependency list
- No separate frontend/backend directories because Streamlit bundles UI and backend logic in one process.

##### Key insights from README
- Describes core components: Streamlit UI, topic modeling, sentiment analysis, interactive charts.
- Mentions deployment on Streamlit Cloud.

##### Main components
a. User Interface Layer
- Browser clients (users interact via web browser)
- Streamlit’s frontend (widgets, upload button, chart panels)
b. Application Logic Layer
- Streamlit server (luxor_dashboard_app.py)
- Request handler: receives uploaded CSV
- Data pre-processing module (e.g., tokenization, cleaning)
c. NLP Processing Modules
- Gensim LDA engine for topic modeling
- TextBlob for sentiment analysis (requires corpora)
d. Visualization Layer
- Plotly chart generator (bar charts, scatter plots)
- Download module to export annotated CSV
e. External/Infrastructure Services
- Streamlit Cloud (CI/CD: GitHub → build container → deploy)
- GitHub repository (source code + docs)
- (Optionally) TextBlob’s online corpus downloader

##### Relationships & data flow
1. User → “Upload CSV” widget
2. Uploaded file → Streamlit server
3. Streamlit server → Pre-processing → NLP modules (LDA, TextBlob)
4. NLP results → Plotly generator → back to browser for rendering
5. Export button → Streamlit server → CSV download to user
6. Deployment pipeline: GitHub → Streamlit Cloud → Streamlit server

##### Architectural patterns & design principles
- Single-process, event-driven UI (Streamlit)
- Modular NLP pipeline: separate concern for data ingestion, modeling, and visualization
- Stateless per user session (each upload runs fresh analysis)
- Use of third-party libraries rather than custom implementations

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interface Layer
    subgraph "User Interface Layer"
        Browser["Browser"]:::ui
        UploadWidget["Upload CSV Widget"]:::ui
        ChartPanel["Chart Panels"]:::ui
        Browser -->|"interact"| UploadWidget
        UploadWidget -->|"CSV file"| StreamlitApp
        PlotlyGen -->|"render charts"| ChartPanel
        DownloadMod -->|"download CSV"| Browser
    end

    %% Application & Processing Layer
    subgraph "Application & Processing"
        StreamlitApp["Streamlit App\n(luxor_dashboard_app.py)"]:::app
        Preprocess["Data Pre-processing Module\n(tokenization, cleaning)"]:::processing
        LDA["Gensim LDA Engine\n(topic modeling)"]:::processing
        TextBlobMod["TextBlob Module\n(sentiment analysis)"]:::processing
        PlotlyGen["Plotly Chart Generator\n(bar, scatter)"]:::processing
        DownloadMod["Download Module\n(export annotated CSV)"]:::processing

        StreamlitApp -->|"calls"| Preprocess
        Preprocess -->|"cleaned text"| LDA
        Preprocess -->|"cleaned text"| TextBlobMod
        LDA -->|"topics JSON"| PlotlyGen
        TextBlobMod -->|"sentiments JSON"| PlotlyGen
        PlotlyGen -->|"charts"| StreamlitApp
        StreamlitApp -->|"export request"| DownloadMod
    end

    %% Sample Data Input
    SampleData["Sample Data CSV\n(luxor_reviews_only.csv)"]:::storage
    SampleData --> UploadWidget

    %% External Dependencies
    subgraph "External Dependencies"
        Requirements["requirements.txt"]:::storage
        Requirements -->|"includes"| StreamlitApp
        Requirements -->|"includes"| LDA
        Requirements -->|"includes"| TextBlobMod
        Requirements -->|"includes"| PlotlyGen
    end

    %% Deployment Pipeline
    subgraph "Deployment"
        GitHub["GitHub Repository"]:::infra
        StreamlitCloud["Streamlit Cloud"]:::infra
        GitHub -->|"CI/CD"| StreamlitCloud
        StreamlitCloud -->|"deploys"| StreamlitApp
    end

    %% Documentation Site
    subgraph "Documentation Site (Jekyll)"
        DocsDir["docs/"]:::docs
        Config["_config.yml"]:::docs
        Includes["_includes/"]:::docs
        Assets["assets/"]:::docs
        IndexMD["index.md"]:::docs
        SetupMD["setup.md"]:::docs
        CustomMD["customization.md"]:::docs
        DocsDir --> Config
        DocsDir --> Includes
        DocsDir --> Assets
        DocsDir --> IndexMD
        DocsDir --> SetupMD
        DocsDir --> CustomMD
    end

    %% Project Metadata
    README["README.md"]:::storage
    LICENSE["LICENSE"]:::storage

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef app fill:#87CEFA,stroke:#000,stroke-width:1px
    classDef processing fill:#98FB98,stroke:#000,stroke-width:1px
    classDef storage fill:#D3D3D3,stroke:#000,stroke-width:1px
    classDef infra fill:#FFD700,stroke:#000,stroke-width:1px
    classDef docs fill:#E6E6FA,stroke:#000,stroke-width:1px

    %% Click Events
    click StreamlitApp "https://github.com/aakinolaj/reviewers-dashboard/blob/main/luxor_dashboard_app.py"
    click SampleData "https://github.com/aakinolaj/reviewers-dashboard/blob/main/luxor_reviews_only.csv"
    click Requirements "https://github.com/aakinolaj/reviewers-dashboard/blob/main/requirements.txt"
    click DocsDir "https://github.com/aakinolaj/reviewers-dashboard/tree/main/docs/"
    click Config "https://github.com/aakinolaj/reviewers-dashboard/blob/main/docs/_config.yml"
    click Includes "https://github.com/aakinolaj/reviewers-dashboard/tree/main/docs/_includes/"
    click Assets "https://github.com/aakinolaj/reviewers-dashboard/tree/main/docs/assets/"
    click IndexMD "https://github.com/aakinolaj/reviewers-dashboard/blob/main/docs/index.md"
    click SetupMD "https://github.com/aakinolaj/reviewers-dashboard/blob/main/docs/setup.md"
    click CustomMD "https://github.com/aakinolaj/reviewers-dashboard/blob/main/docs/customization.md"
    click README "https://github.com/aakinolaj/reviewers-dashboard/blob/main/README.md"
    click LICENSE "https://github.com/aakinolaj/reviewers-dashboard/tree/main/LICENSE"
```
