# siddath/student-support-system architecture

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

- Interactive diagram: https://gitdiagram.com/siddath/student-support-system
- Repository: https://github.com/siddath/student-support-system

## Overview

##### Main Components
- Frontend UI Modules:
- LiveChat (chatbot functionality powered by DialogFlow)
- Dashboard (which includes attendance details, subject lists, and further interactive elements)
- Notifications (managing push notifications and news tags)
- Contacts (storing and retrieving contact information)
- Sign-in (authentication interface)
- Backend & Server:
- server.js and associated Node.js environment (even if minimal, it underpins some server-side aspects)
- Cloud & External Services:
- Firebase & Firestore (for data storage, real-time updates, and pub-sub notifications)
- DialogFlow (for AI chatbot functionality)
- Google Cloud Platform (for overall hosting, scalability, and load balancing)
- Static Assets and Libraries:
- CSS/JS files (organized by module)
- External libraries such as Bootstrap, Font-Awesome, and any custom fonts/images
- Additional assets including images (e.g., logos, timetable graphics)

##### Relationships and Interactions
- Separation between the frontend (client-side views for sign-in, dashboard, notifications, contacts, and LiveChat) and the backend.
- The Sign-in module communicates with the backend service for authentication.
- The Dashboard, Contacts, and Notifications modules fetch/update data from Firestore.
- The LiveChat module routes queries to DialogFlow.
- The server.js (if active in processing requests) acts as an intermediary for API calls and possibly for managing sessions.
- That the project is designed for cloud deployment with Firebase and Google Cloud Platform ensuring scalability through load balancers and distributed services.

##### Architectural Patterns & Technologies
- Modular Architecture: Each module has its own directory and related assets, showing clear separation of concerns.
- Cloud-Centric Design: Emphasize the connections to external cloud services (Firebase, DialogFlow, Cloud hosting). This not only ensures scalability but also secures data access.
- Frontend Design Focus: Incorporate modern UI/UX elements as indicated by the extensive use of HTML5, CSS3, and JavaScript.
- Pub-Sub Model: Especially relevant for the Notifications module where a publish/subscribe pattern could be used for handling real-time notifications.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend Modules"
        LiveChat["LiveChat (HTML, CSS, JS)"]:::frontend
        Dashboard["Dashboard (HTML, CSS, JS)"]:::frontend
        Notifications["Notifications (HTML, CSS, JS)"]:::frontend
        Contacts["Contacts (HTML, CSS, JS)"]:::frontend
        SignIn["Sign-in (HTML, CSS, JS)"]:::frontend
    end

    Server["Backend Server (Node.js & server.js)"]:::backend

    subgraph "Cloud Services"
        Firebase["Firebase/Firestore"]:::cloud
        DialogFlow["DialogFlow (AI Chatbot Service)"]:::cloud
        GCP["Google Cloud Platform"]:::cloud
    end

    %% Frontend to Backend Interaction
    SignIn -->|"authenticates"| Server

    %% Frontend directly interacting with Cloud Services
    Dashboard -->|"fetch/update"| Firebase
    Notifications -->|"fetch/update"| Firebase
    Contacts -->|"fetch/update"| Firebase
    LiveChat -->|"queries"| DialogFlow

    %% Backend to Cloud Services Interaction
    Server -->|"calls API"| Firebase
    Server -->|"scaling"| GCP

    %% Styling
    classDef frontend fill:#AED6F1,stroke:#1F618D,stroke-width:2px;
    classDef backend fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef cloud fill:#D5F5E3,stroke:#27AE60,stroke-width:2px;

    %% Click Events
    click Dashboard "https://github.com/siddath/student-support-system/tree/master/Dashboard"
    click Notifications "https://github.com/siddath/student-support-system/tree/master/Notifications"
    click Contacts "https://github.com/siddath/student-support-system/tree/master/Contacts"
    click SignIn "https://github.com/siddath/student-support-system/tree/master/Sign-in"
    click Server "https://github.com/siddath/student-support-system/blob/master/server.js"
```
