# lopez2306/urbify architecture

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

- Interactive diagram: https://gitdiagram.com/lopez2306/urbify
- Repository: https://github.com/lopez2306/urbify

## Overview

##### Project type and purpose
- Urbify is a monolithic, full‑stack Spring Boot web application for “Gestión Residencial Inteligente.”
- It provides role‑based functionality: Admins manage vigilantes and permissions; Vigilantes register/control entries and exits of people and vehicles.

##### File structure
- Top‑level build files (pom.xml, mvnw) indicate a Maven‑based Spring Boot project.
- src/main/java/com/example/urbify packages follow a classic layered MVC structure:
- config (Spring Security)
- controller (web layer)
- service (business logic)
- repository (data access)
- models (JPA entities)
- src/main/resources/templates + static/img hold Thymeleaf views and static assets.
- application.properties configures database, port, security, etc.

##### README for additional insights
- Confirms use of Spring Boot, Spring Security, SQL (e.g., MySQL or H2), Thymeleaf.
- Describes user roles and main use cases (Admin & Vigilant workflows).

##### Summary of essential architectural elements
- Layers (UI → Controller → Service → Repository → DB).
- Spring Security’s intercept point.
- Role separation (Admin vs. Vigilant vs. Guest).
- Don’t fragment into microservices—this is a single Maven module.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    Browser["Client Browser"]:::ui

    %% Spring Boot Application Container
    subgraph "Spring Boot Application"
        direction TB
        UrbifyApp["UrbifyApplication"]:::presentation

        subgraph "Presentation Layer"
            direction TB
            Templates["Thymeleaf Templates"]:::presentation
            StaticAssets["Static Assets"]:::presentation
            LoginController["LoginController"]:::presentation
            HomeController["HomeController"]:::presentation
            AdminController["AdminController"]:::presentation
            VigilantController["VigilantController"]:::presentation
        end

        subgraph "Security Module"
            direction TB
            SecurityConfig["SecurityConfig"]:::security
            CustomUserDetailsService["CustomUserDetailsService"]:::security
        end

        subgraph "Service Layer"
            direction TB
            AdminService["AdminService"]:::business
            VigilantService["VigilantService"]:::business
            PersonService["PersonService"]:::business
            VehicleService["VehicleService"]:::business
        end

        subgraph "Repository Layer"
            direction TB
            AdminRepository["AdminRepository"]:::data
            VigilantRepository["VigilantRepository"]:::data
            PersonRepository["PersonRepository"]:::data
            VehicleRepository["VehicleRepository"]:::data
        end
    end

    Database["SQL Database"]:::db

    %% Connections
    Browser -->|HTTP Request| SecurityConfig
    SecurityConfig -->|authenticate/authorize| CustomUserDetailsService
    CustomUserDetailsService -->|loadUserByUsername| AdminRepository
    CustomUserDetailsService -->|loadUserByUsername| VigilantRepository
    SecurityConfig -->|passes| LoginController
    SecurityConfig -->|passes| HomeController
    SecurityConfig -->|passes| AdminController
    SecurityConfig -->|passes| VigilantController

    LoginController -->|invoke| AdminService
    AdminController -->|invoke| AdminService
    HomeController -->|invoke| PersonService
    VigilantController -->|invoke| VigilantService
    VigilantController -->|invoke| VehicleService

    AdminService -->|invoke| AdminRepository
    VigilantService -->|invoke| VigilantRepository
    PersonService -->|invoke| PersonRepository
    VehicleService -->|invoke| VehicleRepository

    AdminRepository -->|CRUD| Database
    VigilantRepository -->|CRUD| Database
    PersonRepository -->|CRUD| Database
    VehicleRepository -->|CRUD| Database

    %% Click Events
    click UrbifyApp "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/UrbifyApplication.java"
    click Templates "https://github.com/lopez2306/urbify/tree/main/src/main/resources/templates/"
    click StaticAssets "https://github.com/lopez2306/urbify/tree/main/src/main/resources/static/img/"
    click LoginController "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/controller/LoginController.java"
    click HomeController "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/controller/HomeController.java"
    click AdminController "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/controller/AdminController.java"
    click VigilantController "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/controller/VigilantController.java"
    click SecurityConfig "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/config/SecurityConfig.java"
    click CustomUserDetailsService "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/service/CustomUserDetailsService.java"
    click AdminService "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/service/AdminService.java"
    click VigilantService "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/service/VigilantService.java"
    click PersonService "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/service/PersonService.java"
    click VehicleService "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/service/VehicleService.java"
    click AdminRepository "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/repository/AdminRepository.java"
    click VigilantRepository "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/repository/VigilantRepository.java"
    click PersonRepository "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/repository/PersonRepository.java"
    click VehicleRepository "https://github.com/lopez2306/urbify/blob/main/src/main/java/com/example/urbify/repository/VehicleRepository.java"
    click Database "https://github.com/lopez2306/urbify/blob/main/src/main/resources/application.properties"

    %% Styles
    classDef ui fill:#BBDEFB,stroke:#1E88E5,stroke-width:1px
    classDef presentation fill:#90CAF9,stroke:#1565C0,stroke-width:1px
    classDef security fill:#EF9A9A,stroke:#C62828,stroke-width:1px
    classDef business fill:#A5D6A7,stroke:#2E7D32,stroke-width:1px
    classDef data fill:#FFCC80,stroke:#EF6C00,stroke-width:1px
    classDef db fill:#FFE0B2,stroke:#E65100,stroke-width:1px
```
