# asmaekarmouchi/e-syndic-web-platform architecture

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

- Interactive diagram: https://gitdiagram.com/asmaekarmouchi/e-syndic-web-platform
- Repository: https://github.com/asmaekarmouchi/e-syndic-web-platform

## Overview

##### Project Type and Purpose
- This is a full-stack Java EE web application for managing condominium (“syndic”) operations.
- Purpose: Provide role-based access (Admin, Syndic, Member) to handle payments, charges, incidents, meetings, notifications, reports, and regulatory compliance.

##### Main Components
a. Presentation Layer
- JSP pages (src/main/webapp/*.jsp) & static assets (CSS, JS, images)
- Templates for navigation per role (admin_sidenav.jsp, member_sidenav.jsp, syndic_sidenav.jsp)
b. Controller Layer
- Servlets (com.syndic.servlet.*) handle HTTP requests, route to services/DAOs, forward to JSPs
c. Business/Service Layer
- NotificationService & Mail class for email alerts (com.syndic.mail)
- Potential place for additional services if logic grows
d. Data Access Layer
- DAO interfaces (com.syndic.dao.*DAO) and implementations (…DAOImpl)
- AbstractDAOA base class, Syndic_con for JDBC connection pooling/config
e. Domain Model
- JavaBeans representing entities (Account, Charge, Expense, Incident, Meeting, Member, News, Payment, PaymentFlow, Reclamation, Supplier, Syndic, Task, User)
f. Persistence
- MySQL database (referenced in context.xml & kubernetes/mysql-deployment.yaml)
g. Infrastructure & Deployment
- Dockerfile + docker-compose.yml for local containers (Tomcat + MySQL)
- Kubernetes manifests for production (kubernetes/mysql-deployment.yaml, tomcat-deployment.yaml)
h. Continuous Integration/Deployment
- GitHub Actions workflow ( .github/workflows/deploy.yaml )

##### Relationships and Interactions
- Browser → HTTP request → Tomcat (Docker/K8s)
- Tomcat loads Servlets → invokes DAO layer → executes SQL on MySQL → returns domain objects
- Servlets forward the results to JSPs for rendering
- NotificationService triggers Mail class → SMTP server (configured via email.properties)
- GitHub Actions pushes new Docker images → deployed via Kubernetes

##### Architectural Patterns & Principles
- Model-View-Controller (MVC):
- View = JSPs/CSS/JS
- Controller = Servlets
- Model = JavaBeans + DAO layer
- DAO pattern for persistence abstraction
- Java EE/Servlet container architecture
- Containerization and orchestration for portability & scalability

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Browser (Client)"
        Browser["Browser"]:::external
    end

    subgraph "Tomcat App Server"
        direction TB
        Views["JSP / Static Assets"]:::frontend
        Controllers["Servlet Controllers"]:::server
        Services["NotificationService & Mail"]:::server
        DAO["DAO Layer & JDBC Manager"]:::server
        Beans["Domain Model (JavaBeans)"]:::server
    end

    MySQL["MySQL Database"]:::db
    SMTP["SMTP Mail Server"]:::external

    subgraph "CI/CD & DevOps"
        direction TB
        GH["GitHub Actions"]:::devops
        Registry["Docker Registry"]:::devops
        K8s["Kubernetes"]:::devops
    end

    Browser -->|HTTP Request/Response| Controllers
    Controllers -->|forward/render| Views
    Controllers -->|invoke| Services
    Controllers -->|use| DAO
    DAO -->|JDBC| MySQL
    Services -->|SMTP| SMTP

    GH -->|build images| Registry
    Registry -->|push images| K8s
    K8s -->|deploys app| Controllers
    K8s -->|deploys db| MySQL

    click Views "https://github.com/asmaekarmouchi/e-syndic-web-platform/tree/master/src/main/webapp"
    click Controllers "https://github.com/asmaekarmouchi/e-syndic-web-platform/tree/master/src/main/java/com/syndic/servlet"
    click Services "https://github.com/asmaekarmouchi/e-syndic-web-platform/blob/master/src/main/java/com/syndic/mail/NotificationService.java"
    click Services "https://github.com/asmaekarmouchi/e-syndic-web-platform/blob/master/src/main/java/com/syndic/mail/Mail.java"
    click DAO "https://github.com/asmaekarmouchi/e-syndic-web-platform/tree/master/src/main/java/com/syndic/dao"
    click DAO "https://github.com/asmaekarmouchi/e-syndic-web-platform/blob/master/src/main/java/com/syndic/connection/AbstractDAOA.java"
    click DAO "https://github.com/asmaekarmouchi/e-syndic-web-platform/blob/master/src/main/java/com/syndic/connection/Syndic_con.java"
    click Beans "https://github.com/asmaekarmouchi/e-syndic-web-platform/tree/master/src/main/java/com/syndic/beans"
    click GH "https://github.com/asmaekarmouchi/e-syndic-web-platform/blob/master/.github/workflows/deploy.yaml"

    classDef frontend fill:#E0F7FA,stroke:#006064,color:#006064;
    classDef server fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20;
    classDef db fill:#FFF3E0,stroke:#E65100,color:#E65100;
    classDef external fill:#ECEFF1,stroke:#455A64,color:#455A64;
    classDef devops fill:#F3E5F5,stroke:#6A1B9A,color:#6A1B9A;
```
