# pp492312/scm architecture

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

- Interactive diagram: https://gitdiagram.com/pp492312/scm
- Repository: https://github.com/pp492312/scm

## Overview

##### Project type and purpose
- This is a monolithic full-stack web application (“Smart Contact Manager”) built on Java Spring Boot (backend) with Thymeleaf templates, static HTML/CSS/JS (frontend), and a MySQL database. Its purpose is CRUD management of user contacts, secured via Spring Security, with optional email notifications and image handling.

##### File structure
- Top level:
- package.json / tailwind.config.js – Tailwind CSS build for the frontend
- scm/ – Maven-based Spring Boot project
- node_modules/ – Tailwind build dependencies
- Within scm/src/main/java/com/scm:
- config – Spring configuration (security, OAuth handlers, application beans)
- controllers – MVC controllers handling HTTP requests
- entities – JPA domain models (User, Contact, SocialLink, Providers)
- forms – DTO/form objects for binding and validation
- helpers/validators – utility classes and custom validators
- repositories – Spring Data JPA interfaces
- services + impl – business logic interfaces and implementations (Contact, User, Email, Image)
- scm/src/main/resources:
- static – CSS, JS, images (Tailwind-compiled assets, custom scripts)
- templates – Thymeleaf views (public pages + user dashboards)
- Tests under scm/src/test validate core application startup and services.

##### README for additional insights
- Frontend: HTML, CSS, JavaScript, Tailwind CSS
- Backend: Java, Spring Boot, Spring Web, Security, Data JPA
- Database: MySQL
- Key use case: add/edit/delete contacts, user authentication, profile management

a. Main components
- Browser / Client (renders HTML, CSS, JS)
- Tailwind build tool (node/npm + tailwind.config.js)
- Spring Boot Application (Embedded Tomcat)
– Controllers (API & page controllers)
– Service layer (business logic)
– Repository layer (JPA data access)
– Security module (filters, handlers)
– Helper/Validator modules
- MySQL Database
- External services (SMTP mail server for EmailService)
b. Relationships & interactions
1. Client ⟷ HTTP(S) ⟷ Spring MVC
2. Spring MVC → Service layer → Repository layer → MySQL
3. Service layer → External SMTP (EmailService)
4. Security filters intercept client requests before controllers
5. Static asset pipeline: Developer edits CSS/JS → Tailwind / npm build → static/ → served by Spring Boot
c. Architectural patterns & design principles
- Layered (presentation, business, data)
- MVC for request handling
- Dependency Injection (Spring @Autowired)
- Repository pattern (Spring Data JPA)
- Separation of concerns (config, controllers, services, repositories)
d. Key technologies / frameworks
- Spring Boot, Spring MVC, Spring Security, Spring Data JPA
- Thymeleaf templating
- Tailwind CSS, vanilla JavaScript
- MySQL
- Maven build / dependency management

##### Detailed capture of architectural essentials
- Don’t omit the SecurityConfig chain, custom handlers, or form validation steps
- ContactService and UserService entry points for business logic
- Error-handling flow (e.g., ResourceNotFoundException) if desired

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client and Build Pipeline
    subgraph "Client / Build Pipeline"
        direction TB
        Browser["Browser / Client"]:::frontend
        npm["Tailwind Build Tool"]:::frontend
        Static["Static Assets\n(scm/src/main/resources/static/)"]:::frontend
        Templates["Thymeleaf Templates\n(scm/src/main/resources/templates/)"]:::frontend
        Browser -->|"requests HTML/CSS/JS"| Static
        Browser -->|"requests views"| Templates
        npm -->|"build CSS/JS"| Static
    end

    %% Spring Boot Application
    subgraph "Spring Boot Application" 
        direction TB
        ScmApp["ScmApplication.java"]:::backend
        ScmApp --> AppConfig
        ScmApp --> SecurityLayer
        ScmApp --> WebLayer
        ScmApp --> ServiceLayer
        ScmApp --> DataLayer

        subgraph "Configuration Layer" 
            direction TB
            AppConfig["AppConfig.java\napplication.properties"]:::backend
        end

        subgraph SecurityLayer["Security Layer"]
            direction TB
            SecurityConfig["SecurityConfig.java"]:::backend
            AuthFail["AuthFailtrueHandler.java"]:::backend
            OAuthSuccess["OAuthAuthenicationSuccessHandler.java"]:::backend
        end

        subgraph WebLayer["Web Layer"]
            direction TB
            ApiController["ApiController.java"]:::backend
            AuthController["AuthController.java"]:::backend
            ContactController["ContactController.java"]:::backend
            PageControllers["PageControllers.java"]:::backend
            RootController["RootController.java"]:::backend
            UserController["UserController.java"]:::backend
        end

        subgraph ServiceLayer["Service Layer"]
            direction TB
            ContactSvcI["ContactService.java"]:::backend
            UserSvcI["UserService.java"]:::backend
            EmailSvcI["EmailService.java"]:::backend
            ImageSvcI["ImageService.java"]:::backend
            ContactSvcImpl["ContactServiceImpl.java"]:::backend
            UserSvcImpl["UserServiceImpl.java"]:::backend
            EmailSvcImpl["EmailServiceImpl.java"]:::backend
            ImageSvcImpl["ImageServiceImpl.java"]:::backend
            SecurityDetail["SecurityCustomUserDetailService.java"]:::backend
        end

        subgraph DataLayer["Data Layer"]
            direction TB
            ContactRepo["ContactRepo.java"]:::backend
            UserRepo["UserRepo.java"]:::backend
        end

        subgraph Domain["Domain Models"]
            direction TB
            UserEnt["User.java"]:::backend
            ContactEnt["Contact.java"]:::backend
            SocialLinkEnt["SocialLink.java"]:::backend
            ProvidersEnt["Providers.java"]:::backend
        end

        subgraph Forms["DTO / Forms"]
            direction TB
            UserForm["UserForm.java"]:::backend
            ContactForm["ContactForm.java"]:::backend
            ContactSearchForm["ContactSearchForm.java"]:::backend
        end

        subgraph Helpers["Helpers & Validators"]
            direction TB
            AppConst["AppConstants.java"]:::backend
            HelperCls["Helper.java"]:::backend
            MessageCls["Message.java"]:::backend
            MessageType["MessageType.java"]:::backend
            ResourceNotFound["ResourceNotFoundException.java"]:::backend
            SessionHelper["SessionHelper.java"]:::backend
            FileValidator["FileValidator.java"]:::backend
            ValidFile["ValidFile.java"]:::backend
        end
    end

    %% External Systems
    MySQL["MySQL Database"]:::external
    SMTP["SMTP Mail Server"]:::external

    %% Interactions
    Browser -->|"HTTP GET/POST"| SecurityConfig
    SecurityConfig -->|"proceeds to"| WebLayer
    WebLayer -->|"calls services"| ServiceLayer
    ServiceLayer -->|"uses JPA"| DataLayer
    DataLayer -->|"queries"| MySQL
    ServiceLayer -->|"sends emails"| SMTP

    %% Click Events
    click Browser "https://github.com/pp492312/scm/tree/main/scm/src/main/resources/static/"
    click Templates "https://github.com/pp492312/scm/tree/main/scm/src/main/resources/templates/"
    click npm "https://github.com/pp492312/scm/blob/main/package.json"
    click npm "https://github.com/pp492312/scm/blob/main/tailwind.config.js"
    click npm "https://github.com/pp492312/scm/tree/main/node_modules/"
    click ScmApp "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/ScmApplication.java"
    click ApiController "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/ApiController.java"
    click AuthController "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/AuthController.java"
    click ContactController "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/ContactController.java"
    click PageControllers "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/PageControllers.java"
    click RootController "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/RootController.java"
    click UserController "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/controllers/UserController.java"
    click SecurityConfig "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/config/SecurityConfig.java"
    click AuthFail "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/config/AuthFailtrueHandler.java"
    click OAuthSuccess "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/config/OAuthAuthenicationSuccessHandler.java"
    click ContactSvcI "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/ContactService.java"
    click UserSvcI "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/UserService.java"
    click EmailSvcI "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/EmailService.java"
    click ImageSvcI "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/ImageService.java"
    click ContactSvcImpl "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/impl/ContactServiceImpl.java"
    click UserSvcImpl "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/impl/UserServiceImpl.java"
    click EmailSvcImpl "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/impl/EmailServiceImpl.java"
    click ImageSvcImpl "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/impl/ImageServiceImpl.java"
    click SecurityDetail "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/services/impl/SecurityCustomUserDetailService.java"
    click ContactRepo "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/repositories/ContactRepo.java"
    click UserRepo "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/repositories/UserRepo.java"
    click UserEnt "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/entities/User.java"
    click ContactEnt "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/entities/Contact.java"
    click SocialLinkEnt "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/entities/SocialLink.java"
    click ProvidersEnt "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/entities/Providers.java"
    click UserForm "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/forms/UserForm.java"
    click ContactForm "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/forms/ContactForm.java"
    click ContactSearchForm "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/forms/ContactSearchForm.java"
    click AppConst "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/AppConstants.java"
    click HelperCls "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/Helper.java"
    click MessageCls "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/Message.java"
    click MessageType "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/MessageType.java"
    click ResourceNotFound "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/ResourceNotFoundException.java"
    click SessionHelper "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/helpers/SessionHelper.java"
    click FileValidator "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/validators/FileValidator.java"
    click ValidFile "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/validators/ValidFile.java"
    click AppConfig "https://github.com/pp492312/scm/blob/main/scm/src/main/java/com/scm/config/AppConfig.java"
    click AppConfig "https://github.com/pp492312/scm/blob/main/scm/src/main/resources/application.properties"
    click MySQL "https://github.com/pp492312/scm/tree/main/ "
    click SMTP "https://github.com/pp492312/scm/tree/main/ "

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#0288D1,color:#000;
    classDef backend fill:#E8F5E9,stroke:#2E7D32,color:#000;
    classDef external fill:#FFF3E0,stroke:#EF6C00,color:#000;
```
