# morenaperalta/fixly architecture

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

- Interactive diagram: https://gitdiagram.com/morenaperalta/fixly
- Repository: https://github.com/morenaperalta/fixly

## Overview

##### Project type and purpose
- This is a **backend REST API** (no UI code) built with **Spring Boot** to manage work orders, users, comments, and attachments. It implements JWT-based security, role-based access control, and integrates with MySQL and Cloudinary for persistence and file storage.

##### File structure
- **Top-level files**:
- Dockerfile, docker-compose.yml → containerization
- pom.xml, mvnw → Maven build
- README.md → project overview & architecture
- .github/workflows/ci.yml → GitHub Actions CI
- **src/main/java/com/femcoders/fixly**:
- `FixlyApplication.java` → Spring Boot entry point
- **Packages**:
– `auth`, `user`, `workorder`, `comment`, `attachment`, `status_history` → domain modules
– `shared/config` → SecurityConfig, SwaggerConfig, CloudinaryConfig
– `shared/security` → JWT filter, entry points, user details
– `shared/exception` → global exception handler
- **src/main/resources**:
- application.yml & application-docker.yml → environment configs
- data.sql, banner.txt → seed data & startup banner
- **Tests**: organized mirroring main code structure (unit + integration).

##### README for additional insights
- Describes multi-role user management and full work order lifecycle
- Lists main entities: User, WorkOrder, WorkOrderAssignment, Comment, Attachment
- Mentions external dependencies: MySQL, Cloudinary, Swagger, GitHub Actions CI/CD

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Clients["External Clients\n(Postman, Browser, Mobile)"]:::external

    %% API Layer
    subgraph "API Layer"
        direction TB
        AuthController["AuthController"]:::controller
        UserController["UserController"]:::controller
        WorkOrderController["WorkOrderController"]:::controller
    end

    %% Security Layer
    subgraph "Security Layer"
        direction TB
        JwtAuthFilter["JwtAuthFilter"]:::security
        SecurityConfig["SecurityConfig"]:::configuration
        JwtService["JwtService"]:::security
        CustomAuthenticationEntryPoint["CustomAuthenticationEntryPoint"]:::security
        CustomAccessDeniedHandler["CustomAccessDeniedHandler"]:::security
        CustomUserDetails["CustomUserDetails"]:::security
        GlobalExceptionHandler["GlobalExceptionHandler"]:::exception
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        AuthServiceImpl["AuthServiceImpl"]:::service
        UserServiceImpl["UserServiceImpl"]:::service
        WorkOrderServiceImpl["WorkOrderServiceImpl"]:::service
        WorkOrderIdentifierServiceImpl["WorkOrderIdentifierServiceImpl"]:::service
        WorkOrderMapperServiceImpl["WorkOrderMapperServiceImpl"]:::service
        WorkOrderValidationServiceImpl["WorkOrderValidationServiceImpl"]:::service
    end

    %% Repository Layer
    subgraph "Repository Layer"
        direction TB
        UserRepository["UserRepository"]:::repository
        WorkOrderRepository["WorkOrderRepository"]:::repository
    end

    %% Config Layer
    subgraph "Configuration"
        direction TB
        CloudinaryConfig["CloudinaryConfig"]:::configuration
        SwaggerConfig["SwaggerConfig"]:::configuration
        ApplicationYml["application.yml"]:::configfile
        ApplicationDockerYml["application-docker.yml"]:::configfile
        DataSql["data.sql"]:::configfile
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        MySQL[(MySQL Database)]:::database
        Cloudinary["Cloudinary API"]:::external
    end

    %% Infrastructure
    subgraph "Infrastructure & CI/CD"
        direction TB
        CI["GitHub Actions CI"]:::cicd
        DockerImage["Docker Image\n(Dockerfile)"]:::infra
        DockerCompose["Docker-Compose"]:::infra
    end

    %% Connections
    Clients -->|"HTTPS + JWT"| JwtAuthFilter
    JwtAuthFilter --> AuthController
    JwtAuthFilter --> UserController
    JwtAuthFilter --> WorkOrderController

    AuthController -->|"calls"| AuthServiceImpl
    UserController -->|"calls"| UserServiceImpl
    WorkOrderController -->|"calls"| WorkOrderServiceImpl

    AuthServiceImpl --> UserRepository
    UserServiceImpl --> UserRepository
    WorkOrderServiceImpl --> WorkOrderRepository
    WorkOrderServiceImpl --> WorkOrderIdentifierServiceImpl
    WorkOrderServiceImpl --> WorkOrderMapperServiceImpl
    WorkOrderServiceImpl --> WorkOrderValidationServiceImpl

    UserRepository --> MySQL
    WorkOrderRepository --> MySQL

    WorkOrderServiceImpl -->|"uploads/downloads"| Cloudinary

    SecurityConfig --> JwtAuthFilter
    SecurityConfig --> CustomAuthenticationEntryPoint
    SecurityConfig --> CustomAccessDeniedHandler
    AuthServiceImpl --> JwtService
    JwtAuthFilter --> JwtService
    JwtService --> CustomUserDetails

    GlobalExceptionHandler -.-> AuthController
    GlobalExceptionHandler -.-> UserController
    GlobalExceptionHandler -.-> WorkOrderController

    CloudinaryConfig --> Cloudinary
    SwaggerConfig -.-> Clients

    CI --> DockerImage
    DockerImage --> DockerCompose
    DockerCompose --> MySQL
    DockerCompose --> Cloudinary

    %% Click Events
    click FixlyApplication "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/FixlyApplication.java"
    click AuthController "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/auth/AuthController.java"
    click UserController "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/user/UserController.java"
    click WorkOrderController "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/WorkOrderController.java"
    click SecurityConfig "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/config/SecurityConfig.java"
    click JwtAuthFilter "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/security/jwt/JwtAuthFilter.java"
    click JwtService "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/security/jwt/JwtService.java"
    click CustomAuthenticationEntryPoint "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/security/CustomAuthenticationEntryPoint.java"
    click CustomAccessDeniedHandler "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/security/CustomAccessDeniedHandler.java"
    click CustomUserDetails "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/security/CustomUserDetails.java"
    click AuthServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/auth/services/AuthServiceImpl.java"
    click UserServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/user/services/UserServiceImpl.java"
    click WorkOrderServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/services/implementations/WorkOrderServiceImpl.java"
    click WorkOrderIdentifierServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/services/implementations/WorkOrderIdentifierServiceImpl.java"
    click WorkOrderMapperServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/services/implementations/WorkOrderMapperServiceImpl.java"
    click WorkOrderValidationServiceImpl "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/services/implementations/WorkOrderValidationServiceImpl.java"
    click UserRepository "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/user/UserRepository.java"
    click WorkOrderRepository "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/workorder/WorkOrderRepository.java"
    click CloudinaryConfig "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/config/CloudinaryConfig.java"
    click SwaggerConfig "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/config/SwaggerConfig.java"
    click GlobalExceptionHandler "https://github.com/morenaperalta/fixly/blob/main/src/main/java/com/femcoders/fixly/shared/exception/GlobalExceptionHandler.java"
    click ApplicationYml "https://github.com/morenaperalta/fixly/blob/main/src/main/resources/application.yml"
    click ApplicationDockerYml "https://github.com/morenaperalta/fixly/blob/main/src/main/resources/application-docker.yml"
    click DataSql "https://github.com/morenaperalta/fixly/blob/main/src/main/resources/data.sql"
    click CI "https://github.com/morenaperalta/fixly/blob/main/.github/workflows/ci.yml"
    click DockerImage "https://github.com/morenaperalta/fixly/tree/main/Dockerfile"
    click DockerCompose "https://github.com/morenaperalta/fixly/blob/main/docker-compose.yml"

    %% Styles
    classDef controller fill:#D0E8FF,stroke:#0288D1,stroke-width:1px
    classDef service fill:#D0F2D0,stroke:#2E7D32,stroke-width:1px
    classDef repository fill:#FFE0B2,stroke:#EF6C00,stroke-width:1px
    classDef external fill:#E0E0E0,stroke:#616161,stroke-width:1px
    classDef cicd fill:#E1BEE7,stroke:#8E24AA,stroke-width:1px
    classDef infra fill:#CFD8DC,stroke:#455A64,stroke-width:1px
    classDef security fill:#FCE4EC,stroke:#C2185B,stroke-width:1px
    classDef configuration fill:#FFF9C4,stroke:#F9A825,stroke-width:1px
    classDef configfile fill:#F3E5F5,stroke:#6A1B9A,stroke-width:1px
    classDef database fill:#B2EBF2,stroke:#0097A7,stroke-width:1px
    classDef exception fill:#FFEBEE,stroke:#C62828,stroke-width:1px
```
