# kdb04/attendance-mgmt architecture

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

- Interactive diagram: https://gitdiagram.com/kdb04/attendance-mgmt
- Repository: https://github.com/kdb04/attendance-mgmt

## Overview

##### Project type and purpose
- This is a full-stack Attendance Management System.
- Purpose: provide administrators, teachers, and students with a web interface to manage and view attendance data.

##### File structure
Top-level directories:
- backend – Spring Boot API project (“AttendanceManagementSystem”)
- backend/db – SQL schema, triggers, and helper scripts
- frontend – React.js SPA built with Vite
- documentation – design report PDF

Backend sub-structure follows a layered MVC pattern:
- controller – REST endpoints by role (AdminController, TeacherController, etc.)
- service – business logic (CourseService, SessionService, etc.)
- repository – Spring Data JDBC/JPA interfaces
- model – domain entities (User, Student, Teacher, Course, AttendanceRecord, etc.)
- facade & factory – authentication and user object creation
- util – low-level DBConnection helper
- resources – application.properties for DB URL, credentials

Frontend structure:
- public/index.html, vite.config.js – project entry
- src/ – components for Login, Dashboards (Admin, Teacher, Student), shared CSS, assets
- src/services/api.js – Axios HTTP client

##### README for additional insights
- Confirms Java 17 + Maven, Node.js + npm, MySQL.
- Mentions design patterns: Factory Method, Repository, Facade.
- Database uses triggers for automated attendance updates.

a. Main components to include:
- Client (Browser/React app)
- API Gateway / Web Server (Vite dev server or static file host)
- Spring Boot Application (Controllers, Services, Facades)
- MySQL Database (with schema, triggers, stored procedures)
- External/Support components (DBConnection util, SQL script loader)

b. Relationships and interactions:
1. User interacts with React UI in the browser.
2. UI calls REST endpoints on Spring Boot (via api.js).
3. Dispatcher servlet routes to Controllers.
4. Controllers invoke Services or Facades.
5. Services call Repositories for CRUD operations.
6. Repositories execute SQL on MySQL.
7. Database triggers enforce attendance logic.
8. Responses bubble back to UI.

c. Architectural patterns and design principles:
- MVC / Layered Architecture (Controllers → Services → Repositories)
- Factory Method for user creation (UserFactory)
- Facade to encapsulate authentication complexity (LoginFacade)
- Repository pattern for data access abstraction
- Single-Page Application for frontend
- Clean separation of concerns & dependency injection via Spring

d. Key technologies, frameworks, libraries:
- React.js, Vite, Axios (frontend)
- Java Spring Boot, Maven (backend)
- Spring Web MVC, Spring Data JDBC/JPA
- MySQL, SQL triggers
- CSS modules for styling

##### Elements
- UI → Controller (HTTP request)
- Controller → Service → Repository → Database
- Database → Repository → Controller → UI (responses)
- Blue for frontend components
- Green for backend application layers
- Orange for database and scripts
- Annotations:
- Patterns (Factory, Facade) with small badges or labels

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["Browser"]:::frontend
        subgraph "React SPA" 
            direction TB
            LoginComp["Login Component"]:::frontend
            AdminDash["Admin Dashboard"]:::frontend
            TeacherDash["Teacher Dashboard"]:::frontend
            StudentDash["Student Dashboard"]:::frontend
            SharedDash["Shared Dashboard Components"]:::frontend
        end
        APIService["API Service (axios)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Application (Spring Boot)"
        direction TB
        subgraph "Controllers" 
            direction TB
            AdminCtrl["AdminController"]:::backend
            AuthCtrl["AuthController"]:::backend
            CourseCtrl["CourseController"]:::backend
            SessionCtrl["SessionController"]:::backend
            StudentCtrl["StudentController"]:::backend
            TeacherCtrl["TeacherController"]:::backend
            TestCtrl["TestController"]:::backend
        end
        subgraph "Services"
            direction TB
            CourseSvc["CourseService"]:::backend
            SessionSvc["SessionService"]:::backend
            StudentSvc["StudentService"]:::backend
            TeacherSvc["TeacherService"]:::backend
        end
        subgraph "Repositories"
            direction TB
            CourseRepo["CourseRepository"]:::backend
            StudentRepo["StudentRepository"]:::backend
            TeacherRepo["TeacherRepository"]:::backend
        end
        subgraph "Facades & Factories"
            direction TB
            LoginFacade["LoginFacade"]:::backend
            UserFactory["UserFactory"]:::backend
        end
        DBConn["DBConnection (util)"]:::backend
    end

    %% Database Layer
    subgraph "Database Layer"
        direction TB
        MySQLDB["MySQL Database\n(with triggers)"]:::db
        subgraph "DB Scripts"
            direction TB
            OOADScript["ooad.sql"]:::db
            TriggerScript["triggers.sql"]:::db
            HelperScript["script.py"]:::db
        end
    end

    %% Connections
    Browser -->|interacts with| LoginComp
    Browser -->|interacts with| AdminDash
    Browser -->|interacts with| TeacherDash
    Browser -->|interacts with| StudentDash
    Browser -->|uses| SharedDash

    LoginComp -->|calls API| APIService
    AdminDash -->|calls API| APIService
    TeacherDash -->|calls API| APIService
    StudentDash -->|calls API| APIService
    SharedDash -->|calls API| APIService

    APIService -->|HTTP request| AuthCtrl
    APIService -->|HTTP request| AdminCtrl
    APIService -->|HTTP request| TeacherCtrl
    APIService -->|HTTP request| StudentCtrl
    APIService -->|HTTP request| CourseCtrl
    APIService -->|HTTP request| SessionCtrl

    AuthCtrl -->|uses| LoginFacade
    LoginFacade -->|calls| UserFactory
    AuthCtrl -->|invokes| StudentSvc
    AuthCtrl -->|invokes| TeacherSvc

    AdminCtrl -->|invokes| CourseSvc
    AdminCtrl -->|invokes| SessionSvc

    TeacherCtrl -->|invokes| SessionSvc
    StudentCtrl -->|invokes| SessionSvc
    CourseCtrl -->|invokes| CourseSvc
    SessionCtrl -->|invokes| SessionSvc

    CourseSvc -->|uses| CourseRepo
    SessionSvc -->|uses| CourseRepo
    SessionSvc -->|uses| StudentRepo
    SessionSvc -->|uses| TeacherRepo
    StudentSvc -->|uses| StudentRepo
    TeacherSvc -->|uses| TeacherRepo

    CourseRepo -->|connect via| DBConn
    StudentRepo -->|connect via| DBConn
    TeacherRepo -->|connect via| DBConn

    DBConn -->|executes SQL| MySQLDB
    MySQLDB -->|returns data| DBConn

    OOADScript -->|initializes schema| MySQLDB
    TriggerScript -->|defines triggers| MySQLDB
    HelperScript -->|runs helper tasks| MySQLDB

    %% Click Events
    click frontend "https://github.com/kdb04/attendance-mgmt/tree/main/frontend"
    click Browser "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/index.html"
    click LoginComp "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/Login.jsx"
    click AdminDash "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/AdminDashboard.jsx"
    click TeacherDash "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/TeacherDashboard.jsx"
    click StudentDash "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/StudentDashboard.jsx"
    click SharedDash "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/Dashboard.jsx"
    click APIService "https://github.com/kdb04/attendance-mgmt/blob/main/frontend/src/services/api.js"

    click AttendanceManagementSystem "https://github.com/kdb04/attendance-mgmt/tree/main/backend/AttendanceManagementSystem"
    click AttendanceManagementSystemApplication "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/AttendanceManagementSystemApplication.java"
    click WebConfig "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/config/WebConfig.java"

    click AdminCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/AdminController.java"
    click AuthCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/AuthController.java"
    click CourseCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/CourseController.java"
    click SessionCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/SessionController.java"
    click StudentCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/StudentController.java"
    click TeacherCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/TeacherController.java"
    click TestCtrl "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/controller/TestController.java"

    click CourseSvc "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/service/CourseService.java"
    click SessionSvc "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/service/SessionService.java"
    click StudentSvc "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/service/StudentService.java"
    click TeacherSvc "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/service/TeacherService.java"

    click CourseRepo "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/repository/CourseRepository.java"
    click StudentRepo "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/repository/StudentRepository.java"
    click TeacherRepo "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/repository/TeacherRepository.java"

    click LoginFacade "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/facade/LoginFacade.java"
    click UserFactory "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/factory/UserFactory.java"
    click DBConn "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/java/com/AttendanceManagementSystem/util/DBConnection.java"

    click applicationProperties "https://github.com/kdb04/attendance-mgmt/blob/main/backend/AttendanceManagementSystem/src/main/resources/application.properties"
    click OOADScript "https://github.com/kdb04/attendance-mgmt/blob/main/backend/db/ooad.sql"
    click TriggerScript "https://github.com/kdb04/attendance-mgmt/blob/main/backend/db/triggers.sql"
    click HelperScript "https://github.com/kdb04/attendance-mgmt/blob/main/backend/db/script.py"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#0288D1,stroke-width:1px;
    classDef backend fill:#E8F5E9,stroke:#2E7D32,stroke-width:1px;
    classDef db fill:#FFF3E0,stroke:#F57C00,stroke-width:1px;
```
