# vikramanantha/helmlearning architecture

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

- Interactive diagram: https://gitdiagram.com/vikramanantha/helmlearning
- Repository: https://github.com/vikramanantha/helmlearning

## Overview

##### Main Components
- Frontend: The project includes numerous HTML files (e.g., index.html, login.html, signup.html, admin.html, various class signup pages, and a dedicated “phase3” folder with additional HTML/CSS files). These serve as the user interface for students, teachers, admins, and visitors.
- Backend Services: Key Python scripts like backend.py and class_starting.py indicate a server-side application handling core logic. There are also helper and utility scripts (helper_functions.py, addit_classes.py, addit_tags.py, Google.py, etc.) that provide additional business logic.
- Data Management / Database Layer: Several scripts (moving_to_sql.py, moving_classes_to_sql.py, moving_tags_to_sql.py, moving_teachers_to_sql.py, moving_feedback_to_sql.py) imply data migration and interactions with a SQL database.
- External/Cloud Integrations: There are several integrations:
- File Storage and Asset Management: Scripts for uploading files to Amazon S3 (upload_file_to_s3.py, moving_class_images_to_s3.py).
- Google Integration: Google.py and upload_file_to_googledrive.py likely provide connectivity with Google services.
- Zoom Integration: create_zoom_link.py suggests integration with Zoom for online classes.
- Email/Notification System: Scripts like check_email_to_send.py, timed_email_sending.py indicate features for email notifications.
- Recommendation System: With files such as reco_predict.py, reco_train.py, and recommendation_alg.py – a recommendation module is implemented, perhaps to suggest relevant classes or content.
- Miscellaneous Utilities: Additional scripts for generating QR codes (generate_qrcode.py), creating simple flyers (generate_simple_flyer.py) add to the system’s toolset.

##### Relationships and Interactions
- User interactions occur through the Frontend (HTML pages) which communicate with the Backend (API endpoints or server-side logic in backend.py).
- The Backend interacts with the Database layer to manage persistent class, teacher, and feedback data.
- Various background scripts (data migrations, file uploading scripts) run either as scheduled jobs or triggered events to move data between the local system, SQL databases, S3 buckets, and Google Drive.
- The email system and notification features are linked directly with the backend logic to alert users about events (e.g., confirmations, reminders).
- The recommendation system is integrated into the backend flow—training models and predicting recommendations which might then be displayed on the frontend.

##### Architectural Patterns & Design Principles
- Separation of Concerns: The clear division between frontend (HTML/CSS), backend (Python scripts), and data management (SQL migration scripts) suggests a layered architecture.
- Microservices/Utility Scripts: Several standalone Python scripts (e.g., for uploading files, checking website status, generating QR codes) can be considered independent modules or microservices that perform specific tasks and integrate via the shared backend.
- Scalability & Extensibility: External integrations (Zoom, S3, Google Drive) indicate that the system is designed to easily incorporate third-party services.

##### Technologies, Frameworks, and Libraries
- Python is the main language, and likely a web framework is used within backend.py, though it isn’t explicit in the file names.
- Cloud Services: AWS S3 for file storage, Google APIs for Drive or Gmail functionalities, and Zoom’s API for conferencing.
- SQL Database: Inferred from multiple “moving_X_to_sql.py” scripts used for database migration.
- Recommendation/Machine Learning: Custom recommendation algorithms that process training and prediction data.

## Diagram (Mermaid)

```mermaid
flowchart TB
    User["User"]

    subgraph "Frontend"
        FE_index["index.html"]
        FE_login["login.html"]
        FE_signup["signup.html"]
        FE_admin["admin.html"]
        FE_confirm_signup["confirm-signup.html"]
        FE_confirm_teacher["confirm-teacher-signup.html"]
        FE_confirmation["confirmation.html"]
        FE_class_signup["class-signup.html"]
        FE_class_signup1["class-signup-1.html"]
        FE_class_signup2["class-signup-2.html"]
        FE_class_signup3["class-signup-3.html"]
        FE_class_signup4["class-signup-4.html"]
        FE_dev["dev.html"]
        FE_feedback["feedbackform.html"]
        FE_interest["interest.html"]
        FE_myclass["myclass.html"]
        FE_newsession["newsession.html"]
        FE_selectclass["selectclass.html"]
        FE_upcoming["upcomingclasses.html"]
        FE_verifyteacher["verifyteacher.html"]
        FE_phase3["phase3/ (directory)"]
    end

    subgraph "Backend Services"
        BE_backend["backend.py"]
        BE_class_starting["class_starting.py"]
        BE_helper["helper_functions.py"]
        BE_addit_classes["addit_classes.py"]
        BE_addit_tags["addit_tags.py"]
        BE_Google["Google.py"]
    end

    subgraph "Data Management / Database Layer"
        DB_moving_sql["moving_to_sql.py"]
        DB_moving_classes["moving_classes_to_sql.py"]
        DB_moving_tags["moving_tags_to_sql.py"]
        DB_moving_teachers["moving_teachers_to_sql.py"]
        DB_moving_feedback["moving_feedback_to_sql.py"]
    end

    subgraph "External/Cloud Integrations"
        subgraph "AWS S3"
            EX_S3_upload["upload_file_to_s3.py"]
            EX_S3_images["moving_class_images_to_s3.py"]
        end
        subgraph "Google Services"
            EX_Google_drive["upload_file_to_googledrive.py"]
        end
        subgraph "Zoom"
            EX_Zoom["create_zoom_link.py"]
        end
    end

    subgraph "Email/Notification System"
        EMAIL_check["check_email_to_send.py"]
        EMAIL_timed["timed_email_sending.py"]
    end

    subgraph "Recommendation System"
        REC_predict["reco_predict.py"]
        REC_train["reco_train.py"]
        REC_alg["recommendation_alg.py"]
    end

    subgraph "Miscellaneous Utilities"
        UTIL_qrcode["generate_qrcode.py"]
        UTIL_flyer["generate_simple_flyer.py"]
        UTIL_class_recording["create_class_recordings_folder.py"]
        UTIL_website_down["check_if_website_down.py"]
    end

    %% Connections
    User -->|"HTTPRequests"| FE_index
    FE_index -->|"APIcall"| BE_backend
    BE_backend -->|"DataOps"| DB_moving_sql
    BE_backend -->|"UploadFile"| EX_S3_upload
    BE_backend -->|"GoogleDrive"| EX_Google_drive
    BE_backend -->|"ZoomCall"| EX_Zoom
    BE_backend -->|"SendEmail"| EMAIL_check
    BE_backend -->|"Recommendation"| REC_predict
    BE_backend -->|"UtilityCall"| UTIL_qrcode
    REC_predict -->|"DisplayRec"| FE_index
    DB_moving_sql -->|"TrainingData"| REC_train
    BE_backend -->|"UtilityFlyer"| UTIL_flyer

    %% Click Events for Frontend
    click FE_index "https://github.com/vikramanantha/helmlearning/blob/main/index.html"
    click FE_login "https://github.com/vikramanantha/helmlearning/blob/main/login.html"
    click FE_signup "https://github.com/vikramanantha/helmlearning/blob/main/signup.html"
    click FE_admin "https://github.com/vikramanantha/helmlearning/blob/main/admin.html"
    click FE_confirm_signup "https://github.com/vikramanantha/helmlearning/blob/main/confirm-signup.html"
    click FE_confirm_teacher "https://github.com/vikramanantha/helmlearning/blob/main/confirm-teacher-signup.html"
    click FE_confirmation "https://github.com/vikramanantha/helmlearning/blob/main/confirmation.html"
    click FE_class_signup "https://github.com/vikramanantha/helmlearning/blob/main/class-signup.html"
    click FE_class_signup1 "https://github.com/vikramanantha/helmlearning/blob/main/class-signup-1.html"
    click FE_class_signup2 "https://github.com/vikramanantha/helmlearning/blob/main/class-signup-2.html"
    click FE_class_signup3 "https://github.com/vikramanantha/helmlearning/blob/main/class-signup-3.html"
    click FE_class_signup4 "https://github.com/vikramanantha/helmlearning/blob/main/class-signup-4.html"
    click FE_dev "https://github.com/vikramanantha/helmlearning/blob/main/dev.html"
    click FE_feedback "https://github.com/vikramanantha/helmlearning/blob/main/feedbackform.html"
    click FE_interest "https://github.com/vikramanantha/helmlearning/blob/main/interest.html"
    click FE_myclass "https://github.com/vikramanantha/helmlearning/blob/main/myclass.html"
    click FE_newsession "https://github.com/vikramanantha/helmlearning/blob/main/newsession.html"
    click FE_selectclass "https://github.com/vikramanantha/helmlearning/blob/main/selectclass.html"
    click FE_upcoming "https://github.com/vikramanantha/helmlearning/blob/main/upcomingclasses.html"
    click FE_verifyteacher "https://github.com/vikramanantha/helmlearning/blob/main/verifyteacher.html"
    click FE_phase3 "https://github.com/vikramanantha/helmlearning/tree/main/phase3/"

    %% Click Events for Backend Services
    click BE_backend "https://github.com/vikramanantha/helmlearning/blob/main/backend.py"
    click BE_class_starting "https://github.com/vikramanantha/helmlearning/blob/main/class_starting.py"
    click BE_helper "https://github.com/vikramanantha/helmlearning/blob/main/helper_functions.py"
    click BE_addit_classes "https://github.com/vikramanantha/helmlearning/blob/main/addit_classes.py"
    click BE_addit_tags "https://github.com/vikramanantha/helmlearning/blob/main/addit_tags.py"
    click BE_Google "https://github.com/vikramanantha/helmlearning/blob/main/Google.py"

    %% Click Events for Data Management / Database Layer
    click DB_moving_sql "https://github.com/vikramanantha/helmlearning/blob/main/moving_to_sql.py"
    click DB_moving_classes "https://github.com/vikramanantha/helmlearning/blob/main/moving_classes_to_sql.py"
    click DB_moving_tags "https://github.com/vikramanantha/helmlearning/blob/main/moving_tags_to_sql.py"
    click DB_moving_teachers "https://github.com/vikramanantha/helmlearning/blob/main/moving_teachers_to_sql.py"
    click DB_moving_feedback "https://github.com/vikramanantha/helmlearning/blob/main/moving_feedback_to_sql.py"

    %% Click Events for External/Cloud Integrations - AWS S3
    click EX_S3_upload "https://github.com/vikramanantha/helmlearning/blob/main/upload_file_to_s3.py"
    click EX_S3_images "https://github.com/vikramanantha/helmlearning/blob/main/moving_class_images_to_s3.py"
    %% Click for Google Services
    click EX_Google_drive "https://github.com/vikramanantha/helmlearning/blob/main/upload_file_to_googledrive.py"
    %% Click for Zoom
    click EX_Zoom "https://github.com/vikramanantha/helmlearning/blob/main/create_zoom_link.py"

    %% Click Events for Email/Notification System
    click EMAIL_check "https://github.com/vikramanantha/helmlearning/blob/main/check_email_to_send.py"
    click EMAIL_timed "https://github.com/vikramanantha/helmlearning/blob/main/timed_email_sending.py"

    %% Click Events for Recommendation System
    click REC_predict "https://github.com/vikramanantha/helmlearning/blob/main/reco_predict.py"
    click REC_train "https://github.com/vikramanantha/helmlearning/blob/main/reco_train.py"
    click REC_alg "https://github.com/vikramanantha/helmlearning/blob/main/recommendation_alg.py"

    %% Click Events for Miscellaneous Utilities
    click UTIL_qrcode "https://github.com/vikramanantha/helmlearning/blob/main/generate_qrcode.py"
    click UTIL_flyer "https://github.com/vikramanantha/helmlearning/blob/main/generate_simple_flyer.py"
    click UTIL_class_recording "https://github.com/vikramanantha/helmlearning/blob/main/create_class_recordings_folder.py"
    click UTIL_website_down "https://github.com/vikramanantha/helmlearning/blob/main/check_if_website_down.py"

    %% Styles
    classDef user fill:#dddddd,stroke:#333,stroke-width:2px;
    classDef frontend fill:#ffcccb,stroke:#333,stroke-width:2px;
    classDef backend fill:#add8e6,stroke:#333,stroke-width:2px;
    classDef database fill:#98fb98,stroke:#333,stroke-width:2px;
    classDef external fill:#ffdab9,stroke:#333,stroke-width:2px;
    classDef email fill:#fffacd,stroke:#333,stroke-width:2px;
    classDef recommendation fill:#90ee90,stroke:#333,stroke-width:2px;
    classDef utilities fill:#e0ffff,stroke:#333,stroke-width:2px;

    class User user;
    class FE_index,FE_login,FE_signup,FE_admin,FE_confirm_signup,FE_confirm_teacher,FE_confirmation,FE_class_signup,FE_class_signup1,FE_class_signup2,FE_class_signup3,FE_class_signup4,FE_dev,FE_feedback,FE_interest,FE_myclass,FE_newsession,FE_selectclass,FE_upcoming,FE_verifyteacher,FE_phase3 frontend;
    class BE_backend,BE_class_starting,BE_helper,BE_addit_classes,BE_addit_tags,BE_Google backend;
    class DB_moving_sql,DB_moving_classes,DB_moving_tags,DB_moving_teachers,DB_moving_feedback database;
    class EX_S3_upload,EX_S3_images,EX_Google_drive,EX_Zoom external;
    class EMAIL_check,EMAIL_timed email;
    class REC_predict,REC_train,REC_alg recommendation;
    class UTIL_qrcode,UTIL_flyer,UTIL_class_recording,UTIL_website_down utilities;
```
