# damianmielcarek/crm architecture

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

- Interactive diagram: https://gitdiagram.com/damianmielcarek/crm
- Repository: https://github.com/damianmielcarek/crm

## Overview

##### Main Components Identification
The system is a Spring Boot-based CRM application with the following key components:

A. Backend Layer Components:
- Security Layer (SecurityConfig.java)
- Web Configuration (WebAppConfig.java)
- Controllers Layer
- Service Layer
- Repository Layer
- Entity Layer
- Export Functionality
- View Resolvers

B. Database Layer:
- MySQL Database

C. Frontend Layer:
- Thymeleaf Templates
- Static Resources

**[Client/Browser] → [Security Layer] → [Controllers] → [Services] → [Repositories] → [Database]**

**[Export Services (PDF/CSV/Excel)] ← [View Resolvers] → [Templates]**

##### Component Details

Security Layer:
- Spring Security configuration
- Role-based access control (User, Manager, Owner, Admin)

Controller Layer:
- CustomerController
- ContractController
- UserController
- Export Controllers (CSV, PDF)
- RegisterController

Service Layer:
- CustomerService
- ContractService
- UserService
- PdfService
- RoleService

Repository Layer:
- CustomerRepository
- ContractRepository
- UserRepository
- PdfRepository
- RoleRepository

Entity Layer:
- Customer
- Contract
- User
- Role
- Category
- Status

Export Functionality:
- PDF Generation
- CSV Export
- Excel Export

- Black: Regular data flow
- Red: Security-related flow
- Green: Export operations

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef security fill:#ff6b6b,stroke:#333,stroke-width:2px
    classDef controller fill:#4ecdc4,stroke:#333,stroke-width:2px
    classDef service fill:#87d37c,stroke:#333,stroke-width:2px
    classDef repository fill:#f7d794,stroke:#333,stroke-width:2px
    classDef database fill:#95a5a6,stroke:#333,stroke-width:2px
    classDef frontend fill:#f39c12,stroke:#333,stroke-width:2px
    classDef export fill:#9b59b6,stroke:#333,stroke-width:2px
    classDef entity fill:#3498db,stroke:#333,stroke-width:2px

    %% Client Layer
    Client[Web Browser]

    %% Security Layer
    subgraph Security[Spring Security]
        SEC[Spring SecurityConfig]:::security
        WEB[Spring WebAppConfig]:::security
    end

    %% Controllers Layer
    subgraph Controllers[Spring MVC Controllers]
        CUST_C[CustomerController]:::controller
        CONT_C[ContractController]:::controller
        USER_C[UserController]:::controller
        CSV_C[CSVController]:::controller
        PDF_C[PdfController]:::controller
    end

    %% Service Layer
    subgraph Services[Spring Services]
        CUST_S[CustomerService]:::service
        CONT_S[ContractService]:::service
        USER_S[UserService]:::service
        PDF_S[PdfService]:::service
    end

    %% Repository Layer
    subgraph Repositories[Spring Data JPA Repositories]
        CUST_R[CustomerRepository]:::repository
        CONT_R[ContractRepository]:::repository
        USER_R[UserRepository]:::repository
        PDF_R[PdfRepository]:::repository
    end

    %% Entity Layer
    subgraph Entities[JPA Entities]
        CUST_E[Customer Entity]:::entity
        CONT_E[Contract Entity]:::entity
        USER_E[User Entity]:::entity
        ROLE_E[Role Entity]:::entity
    end

    %% Export Layer
    subgraph Export[Export Views]
        CSV_V[Apache Commons CSV]:::export
        PDF_V[iText PDF]:::export
        XLS_V[Apache POI Excel]:::export
    end

    %% Frontend Layer
    subgraph Frontend[Thymeleaf Templates]
        CUST_T[Customer Templates]:::frontend
        CONT_T[Contract Templates]:::frontend
        USER_T[User Templates]:::frontend
        PDF_T[PDF Templates]:::frontend
    end

    %% Database
    DB[(MySQL Database)]:::database

    %% Relationships
    Client --> SEC
    SEC --> WEB
    WEB --> Controllers
    
    %% Controller to Service
    CUST_C --> CUST_S
    CONT_C --> CONT_S
    USER_C --> USER_S
    PDF_C --> PDF_S
    CSV_C --> CUST_S
    
    %% Service to Repository
    CUST_S --> CUST_R
    CONT_S --> CONT_R
    USER_S --> USER_R
    PDF_S --> PDF_R
    
    %% Repository to Database
    CUST_R --> DB
    CONT_R --> DB
    USER_R --> DB
    PDF_R --> DB
    
    %% Export Flows
    PDF_C --> PDF_V
    CSV_C --> CSV_V
    
    %% Template Relationships
    CUST_C --> CUST_T
    CONT_C --> CONT_T
    USER_C --> USER_T
    PDF_C --> PDF_T

    %% Click Events
    click SEC "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/SecurityConfig.java"
    click WEB "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/WebAppConfig.java"
    click CUST_C "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/controller/CustomerController.java"
    click CONT_C "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/controller/ContractController.java"
    click USER_C "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/controller/UserController.java"
    click CSV_C "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/controller/CSVController.java"
    click PDF_C "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/controller/PdfController.java"
    click CUST_S "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/service/CustomerService.java"
    click CONT_S "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/service/ContractService.java"
    click USER_S "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/service/UserService.java"
    click PDF_S "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/service/PdfService.java"
    click CUST_R "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/repository/CustomerRepository.java"
    click CONT_R "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/repository/ContractRepository.java"
    click USER_R "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/repository/UserRepository.java"
    click PDF_R "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/repository/PdfRepository.java"
    click CUST_E "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/entity/Customer.java"
    click CONT_E "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/entity/Contract.java"
    click USER_E "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/entity/User.java"
    click ROLE_E "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/entity/Role.java"
    click CSV_V "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/view/CsvView.java"
    click PDF_V "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/view/PdfView.java"
    click XLS_V "https://github.com/DamianMielcarek/crm/blob/master/src/main/java/crm/view/ExcelView.java"
    click CUST_T "https://github.com/DamianMielcarek/crm/tree/master/src/main/resources/templates/customer"
    click CONT_T "https://github.com/DamianMielcarek/crm/tree/master/src/main/resources/templates/contract"
    click USER_T "https://github.com/DamianMielcarek/crm/tree/master/src/main/resources/templates/user"
    click PDF_T "https://github.com/DamianMielcarek/crm/tree/master/src/main/resources/templates/pdf"
```
