# adawang1210/mind_map architecture

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

- Interactive diagram: https://gitdiagram.com/adawang1210/mind_map
- Repository: https://github.com/adawang1210/mind_map

## Overview

##### Project Type and Purpose
- This is a full-stack single-page application combining a Vue.js (Vue 3) frontend and a Python Flask backend.
- Purpose: allow users to upload PDF documents, analyze them via AI (Google Gemini + Sentence Transformers), automatically generate an interactive mind map, and serve a quiz based on the content.

##### Key Architectural Components
a. Client / Browser
- Renders the Vue.js SPA
- Three main views/components: HomePage, MindMap (MindElixir visualization), QuizPage (interactive quiz)
b. Frontend (Vue 3 SPA)
- Components: AppHeader, AppFooter, HomePage.vue, MindMap.vue, QuizPage.vue
- Plugins: Vuetify (UI), Vue Router (routing), Axios (HTTP requests)
- MindElixir library for rendering mind maps
c. Backend (Flask API)
- app.py: Flask application, CORS enabled, serves API endpoints and optionally serves built frontend from backend/dist
- pdf_processor.py: handles file uploads, invokes Google Gemini API and Sentence Transformers to parse and structure content
- quiz_generator.py: generates quiz questions and answers using AI prompts (prompt.txt)
- uploads/: stores user-uploaded PDF files
- requirements.txt: dependencies (Flask, Flask-CORS, transformers, etc.)
d. External Services
- Google Generative AI (Gemini-1.5-pro)
- Sentence Transformers models (local inference for semantic analysis)
e. Data Storage
- File system upload directory (no persistent DB; ephemeral storage of PDFs and generated artifacts)

##### Interactions and Data Flow
1. User in Browser → interacts with Vue UI (HomePage.vue) → triggers “Upload PDF”
2. Vue + Axios → HTTP POST `/upload` (Flask app.py) → file lands in `/uploads`
3. Flask pdf_processor.py
- Reads PDF, calls Sentence Transformers for semantic segmentation
- Sends text snippets to Gemini API for deeper analysis
- Produces a JSON structure representing the mind map
4. Flask returns JSON to Vue → MindMap.vue uses MindElixir to render the map
5. User navigates to QuizPage → Vue triggers GET `/quiz` → Flask quiz_generator.py reads mind-map JSON or text, uses Gemini prompts to generate questions/answers → returns quiz JSON → Vue renders interactive quiz and scoring

##### Architectural Patterns & Design Principles
- SPA (Single-Page Application) on frontend, RESTful JSON API on backend
- Separation of concerns: UI layer vs. business logic vs. AI/ML processing
- Modular Python backend: distinct modules for PDF processing and quiz generation
- File-based storage for uploads (could evolve to object storage or database)
- CORS to allow cross-origin calls from port 8080 → 5001

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    Browser["Browser / Client"]:::ui

    %% Frontend Layer
    subgraph "Frontend (Vue 3 SPA)"
        direction TB
        MainJS["main.js"]:::ui
        AppVue["App.vue"]:::ui
        Router["router/index.js"]:::ui
        Vuetify["plugins/vuetify.js"]:::ui
        AppHeader["AppHeader.vue"]:::ui
        AppFooter["AppFooter.vue"]:::ui
        HomePage["HomePage.vue"]:::ui
        MindMapView["MindMap.vue"]:::ui
        QuizPage["QuizPage.vue"]:::ui
    end

    Browser -->|"loads SPA"| MainJS
    MainJS -->|"bootstraps App"| AppVue
    AppVue -->|"uses Router"| Router
    AppVue --> AppHeader
    AppVue --> AppFooter
    Router --> HomePage
    Router --> MindMapView
    Router --> QuizPage

    HomePage -->|"POST /upload"| BackendApp
    MindMapView -->|"renders MindElixir"| MindMapView
    QuizPage -->|"GET /quiz"| BackendApp

    %% Backend Layer
    subgraph "Backend (Flask API)" 
        direction TB
        BackendApp["app.py"]:::api
        PDFProc["pdf_processor.py"]:::api
        QuizGen["quiz_generator.py"]:::api
        PromptFile["prompt.txt"]:::api
        Requirements["requirements.txt"]:::api
        Dist["dist/"]:::api
    end

    BackendApp --> PDFProc
    BackendApp --> QuizGen
    BackendApp --> Dist
    PDFProc -->|"reads/writes PDF"| Uploads
    QuizGen --> PromptFile

    %% Data Storage
    Uploads["/uploads directory"]:::storage

    %% External Services
    ST["Sentence Transformers models"]:::external
    Gemini["Google Gemini-1.5-pro API"]:::external

    PDFProc -.->|"semantic segmentation"| ST
    PDFProc -.->|"analysis requests"| Gemini
    QuizGen -.->|"question prompts"| Gemini

    %% Click Events
    click HomePage "https://github.com/adawang1210/mind_map/blob/main/frontend/src/views/HomePage.vue"
    click MindMapView "https://github.com/adawang1210/mind_map/blob/main/frontend/src/views/MindMap.vue"
    click QuizPage "https://github.com/adawang1210/mind_map/blob/main/frontend/src/views/QuizPage.vue"
    click AppHeader "https://github.com/adawang1210/mind_map/blob/main/frontend/src/views/AppHeader.vue"
    click AppFooter "https://github.com/adawang1210/mind_map/blob/main/frontend/src/views/AppFooter.vue"
    click AppVue "https://github.com/adawang1210/mind_map/blob/main/frontend/src/App.vue"
    click MainJS "https://github.com/adawang1210/mind_map/blob/main/frontend/src/main.js"
    click Router "https://github.com/adawang1210/mind_map/blob/main/frontend/src/router/index.js"
    click Vuetify "https://github.com/adawang1210/mind_map/blob/main/frontend/src/plugins/vuetify.js"
    click BackendApp "https://github.com/adawang1210/mind_map/blob/main/backend/app.py"
    click PDFProc "https://github.com/adawang1210/mind_map/blob/main/backend/pdf_processor.py"
    click QuizGen "https://github.com/adawang1210/mind_map/blob/main/backend/quiz_generator.py"
    click PromptFile "https://github.com/adawang1210/mind_map/blob/main/backend/prompt.txt"
    click Uploads "https://github.com/adawang1210/mind_map/tree/main/backend/uploads/"
    click Requirements "https://github.com/adawang1210/mind_map/blob/main/backend/requirements.txt"
    click Dist "https://github.com/adawang1210/mind_map/tree/main/backend/dist/"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366d6,stroke-width:1px
    classDef api fill:#E6F4EA,stroke:#22863A,stroke-width:1px
    classDef storage fill:#F0F0F0,stroke:#6a737d,stroke-width:1px
    classDef external fill:#FFF5B1,stroke:#735C0F,stroke-width:1px
```
