# dannybobo/shetrue-punch-in-system architecture

> Architecture diagram of the GitHub repository dannybobo/shetrue-punch-in-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dannybobo/shetrue-punch-in-system
- Repository: https://github.com/dannybobo/shetrue-punch-in-system

## Overview

##### Main Components

A. Client Layer
- Web Browser (accessing JSP pages)
- CSS styling (from /css/style.css)

B. Presentation Layer (Web Layer)
- JSP Pages (login.jsp, main.jsp, etc.)
- Servlets (organized by functionality)
- Authentication (LoginServlet, LogoutServlet)
- Member Management (MemberServlet, MemberAddServlet, etc.)
- Punch Operations (PunchInServlet, PunchOutServlet)
- Record Management (RecordServlet, RecordDeleteServlet)
- Memo Management (MemoServlet, MemoPostServlet, etc.)

C. Business Layer
- Model Classes
- Person.java
- Record.java
- Memo.java

D. Data Access Layer
- DAO Classes
- PersonDao.java
- RecordDao.java
- MemoDao.java

E. Database Layer
- MySQL Database (referenced in st.sql)

- [Client Layer]
- ↓
- [Presentation Layer]
- ↓
- [Business Layer]
- ↓
- [Data Access Layer]
- ↓
- [Database Layer]

##### Component Relationships

- User interactions from client to servlets
- Servlet calls to model classes
- Model interactions with DAOs
- DAO connections to database

##### Technical Details

- Technology Stack:
- Tomcat 10
- Java EE
- MySQL 8.0
- JDBC Connector
- JSP/Servlet architecture

Create distinct sections for:

##### Implementation Notes

- Use standardized UML notation where applicable
- Notes for critical configurations
- Security boundaries
- Session management

**→ : Request/Response Flow**
**⇢ : Data Flow**
**□ : Servlet**
**○ : Model**
**◇ : DAO**
**▭ : Database Table**

Remember to:
- Related components
- Clear boundaries between layers
- Important configuration files (web.xml)
- Security checkpoints
- Database relationships

This architecture represents a classic MVC pattern in a Java EE environment, with clear separation of concerns between presentation, business logic, and data access layers.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef client fill:#a8d1f0,stroke:#333
    classDef servlet fill:#90EE90,stroke:#333
    classDef model fill:#FFE5B4,stroke:#333
    classDef dao fill:#FFA07A,stroke:#333
    classDef db fill:#E6E6E6,stroke:#333
    classDef config fill:#DDA0DD,stroke:#333

    %% Client Layer
    subgraph CL[Client Layer]
        Browser["Web Browser"]:::client
        CSS["CSS Styling"]:::client
        JSP["JSP Pages"]:::client
    end
    click CSS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/webapp/css/style.css"
    click JSP "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/webapp/*.jsp"

    %% Presentation Layer
    subgraph PL[Presentation Layer]
        subgraph Auth[Authentication]
            LoginS["LoginServlet"]:::servlet
            LogoutS["LogoutServlet"]:::servlet
        end
        
        subgraph Member[Member Management]
            MemberS["MemberServlet"]:::servlet
            MemberAddS["MemberAddServlet"]:::servlet
            MemberEditS["MemberEditServlet"]:::servlet
            MemberDeleteS["MemberDeleteServlet"]:::servlet
        end
        
        subgraph Punch[Punch Operations]
            PunchInS["PunchInServlet"]:::servlet
            PunchOutS["PunchOutServlet"]:::servlet
        end
        
        subgraph Record[Record Management]
            RecordS["RecordServlet"]:::servlet
            RecordDeleteS["RecordDeleteServlet"]:::servlet
        end
        
        subgraph Memo[Memo Management]
            MemoS["MemoServlet"]:::servlet
            MemoPostS["MemoPostServlet"]:::servlet
            MemoDeleteS["MemoDeleteServlet"]:::servlet
        end
    end

    %% Click events for Servlets
    click LoginS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/LoginServlet.java"
    click LogoutS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/LogoutServlet.java"
    click MemberS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemberServlet.java"
    click MemberAddS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemberAddServlet.java"
    click MemberEditS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemberEditServlet.java"
    click MemberDeleteS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemberDeleteServlet.java"
    click PunchInS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/PunchInServlet.java"
    click PunchOutS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/PunchOutServlet.java"
    click RecordS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/RecordServlet.java"
    click RecordDeleteS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/RecordDeleteServlet.java"
    click MemoS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemoServlet.java"
    click MemoPostS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemoPostServlet.java"
    click MemoDeleteS "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/servlet/MemoDeleteServlet.java"

    %% Business Layer
    subgraph BL[Business Layer]
        Person["Person Model"]:::model
        Record["Record Model"]:::model
        Memo["Memo Model"]:::model
    end

    %% Click events for Models
    click Person "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/model/Person.java"
    click Record "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/model/Record.java"
    click Memo "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/model/Memo.java"

    %% Data Access Layer
    subgraph DAL[Data Access Layer]
        PersonDAO["PersonDAO"]:::dao
        RecordDAO["RecordDAO"]:::dao
        MemoDAO["MemoDAO"]:::dao
    end

    %% Click events for DAOs
    click PersonDAO "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/dao/PersonDao.java"
    click RecordDAO "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/dao/RecordDao.java"
    click MemoDAO "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/java/dao/MemoDao.java"

    %% Database Layer
    subgraph DB[Database Layer]
        MySQL["MySQL Database"]:::db
    end
    click MySQL "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/st.sql"

    %% Configuration
    Config["web.xml"]:::config
    click Config "https://github.com/Dannybobo/SHETRUE-punch-in-system/blob/main/ST01/src/main/webapp/WEB-INF/web.xml"

    %% Relationships
    Browser --> CSS
    Browser --> JSP
    JSP --> Auth
    JSP --> Member
    JSP --> Punch
    JSP --> Record
    JSP --> Memo
    
    Auth --> Person
    Member --> Person
    Punch --> Record
    Record --> Record
    Memo --> Memo
    
    Person --> PersonDAO
    Record --> RecordDAO
    Memo --> MemoDAO
    
    PersonDAO --> MySQL
    RecordDAO --> MySQL
    MemoDAO --> MySQL

    %% Legend
    subgraph Legend
        L1["Client Component"]:::client
        L2["Servlet"]:::servlet
        L3["Model"]:::model
        L4["DAO"]:::dao
        L5["Database"]:::db
        L6["Configuration"]:::config
    end
```
