# relic7663/utncoindev-main architecture

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

- Interactive diagram: https://gitdiagram.com/relic7663/utncoindev-main
- Repository: https://github.com/relic7663/utncoindev-main

## Overview

##### Project type and purpose
- This is a full-stack Jakarta EE web application (“utncoin”) for a university virtual-coin platform.
- Frontend: JSF-based webapp (XHTML pages under src/main/webapp).
- Backend: Jakarta EE modules (Java packages: core, security, audit, project, jakarta).
- Persistence: JPA entities + PostgreSQL (configured in persistence.xml).
- Objectives: attendance tracking, coin issuance, rewards, badges, AAA and audit.

##### File structure
Top-level folders
- src/main/webapp: UI layer (JSF pages, CSS, images)
- src/main/java packages:
– ec.utncoin.security: authentication/authorization controllers, DTOs, ManagerSecurity
– ec.utncoin.audit: audit controllers, ManagerAudit, AudBitacora entity
– ec.utncoin.core: core business (events, coins, wallets), entities & DAOs
– ec.utncoin.project: project-management controllers, managers
– ec.utncoin.jakarta.hello: sample REST endpoints (HelloApplication)
- src/main/resources/META-INF/persistence.xml: JPA config
- Dockerfile, pom.xml, Maven wrapper: build & deployment artifacts

##### README for additional insights
- Defines high-level modules: Security (AAA), Events & Attendance, Coin Issuer (bank), Rewards & Badges, Advertising.
- Technology stack: Jakarta EE, PostgreSQL, JSF frontend, JWT recommended.

##### Main components & relationships
a. User personas (external actors):
- Student, Administrator, Sponsor (Auspiciante)
b. Frontend layer (UI):
- JSF pages (login.xhtml, menu.xhtml, etc.) served by Web Container (e.g., Tomcat/Payara)
- REST endpoints (HelloWorldResource) for potential mobile/web API
c. Backend layer:
- Authentication & Authorization Module (ec.utncoin.security): BeanSegLogin, ManagerSecurity, JWT/token validation
- Audit Module (ec.utncoin.audit): BeanAudBitacora, ManagerAudit, record all critical actions
- Core Business Module (ec.utncoin.core):
- Event & Attendance Manager (entities: EveEvent, EveAttendance, etc.)
- Coin Issuer (entities: BnkTransaction, BnkUserBalance, WallWallet)
- Reward & Badge Manager (RanAchievement, BnkProduct, etc.)
- Project Module (ec.utncoin.project): project/task management (PryProyecto, PryTarea)
- REST API Module (ec.utncoin.jakarta): example JAX-RS endpoints
d. Persistence/Data layer:
- JPA Entities → PostgreSQL DB (tables for users, roles, events, transactions, rewards, audit logs)
e. External services:
- University email/identity provider (for initial login)
- Sponsor systems (for coupon validations, ad campaigns)
- Cloud DB hosting, JWT issuer (if external)

##### Architectural patterns and principles
- Layered architecture:
- Presentation (JSF pages)
- Controller/Managed Beans (JSF + JAX-RS)
- Service/Manager layer (business logic)
- Repository/DAO (JPA via ManagerDAO)
- Database
- Modularity by functional package (security, audit, core, project)
- AAA (Authentication, Authorization, Auditing) cross-cutting concern
- Use of Jakarta EE standard (CDI, JPA, JSF, JAX-RS) for portability
- Scalability: stateless beans, externalized config (persistence.xml, Dockerfile)

##### Essential elements to capture
- All five high-level modules (Security, Events/Attendance, Coin Issuer, Rewards/Badges, Advertising)
- JPA persistence as a shared service under all modules
- The audit trail as a cross-cutting component receiving logs from each module
- External identity/email provider for authentication
- Docker container or application server for deployment

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    subgraph Actors
        direction TB
        Student["Student"]:::external
        Administrator["Administrator"]:::external
        Sponsor["Sponsor"]:::external
    end

    %% Presentation Layer
    JSFUI["JSF UI (XHTML Pages)"]:::frontend
    click JSFUI "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/webapp"

    %% Business Modules
    subgraph "Business Modules"
        direction TB
        SecurityMod["Security Module"]:::service
        click SecurityMod "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/security"
        SecControllers["Security Controllers"]:::service
        click SecControllers "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/security/controllers"
        ManagerSecurity["ManagerSecurity"]:::service
        click ManagerSecurity "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/security/model/managers/ManagerSecurity.java"
        LoginDTO["LoginDTO"]:::service
        click LoginDTO "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/security/model/dtos/LoginDTO.java"
        SecurityUI["Security UI Pages"]:::frontend
        click SecurityUI "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/webapp/security/administrator"

        AuditMod["Audit Module"]:::service
        click AuditMod "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/audit"
        BeanAud["BeanAudBitacora"]:::service
        click BeanAud "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/audit/controllers/BeanAudBitacora.java"
        ManagerAudit["ManagerAudit"]:::service
        click ManagerAudit "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/audit/model/managers/ManagerAudit.java"
        AuditUI["Audit UI Pages"]:::frontend
        click AuditUI "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/webapp/audit/auditor"

        CoreMod["Core Business Module"]:::service
        click CoreMod "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/core"
        CoreControllers["Core Controllers"]:::service
        click CoreControllers "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/core/controllers"
        CoreEntities["Core Entities"]:::data
        click CoreEntities "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/core/model/entities"
        ManagerDAO["ManagerDAO"]:::data
        click ManagerDAO "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/core/model/managers/ManagerDAO.java"

        ProjectMod["Project Module"]:::service
        click ProjectMod "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/project"
        BeanProject["BeanProjectLeader"]:::service
        click BeanProject "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/project/controllers/BeanProjectLeader.java"
        ManagerPry["ManagerPryProyecto"]:::service
        click ManagerPry "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/project/model/managers/ManagerPryProyecto.java"

        RestMod["REST API Module"]:::service
        click RestMod "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/src/main/java/ec/utncoin/jakarta/hello"
        HelloApp["HelloApplication"]:::service
        click HelloApp "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/java/ec/utncoin/jakarta/hello/HelloApplication.java"
    end

    %% Data Layer
    DB["PostgreSQL Database"]:::data
    click DB "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/src/main/resources/META-INF/persistence.xml"

    %% Deployment & Build
    Docker["Dockerfile"]:::external
    click Docker "https://github.com/relic7663/utncoindev-main/tree/main/utncoin/Dockerfile"
    POM["pom.xml"]:::external
    click POM "https://github.com/relic7663/utncoindev-main/blob/main/utncoin/pom.xml"

    %% External Systems
    subgraph "External Systems"
        direction TB
        IdentityProv["University Identity Provider"]:::external
        SponsorSys["Sponsor Systems"]:::external
        JWTIssuer["External JWT Issuer"]:::external
        CloudDB["Cloud DB Hosting"]:::external
    end

    %% Connections
    Student -->|"HTTP/HTTPS"| JSFUI
    Administrator -->|"HTTP/HTTPS"| JSFUI
    Sponsor -->|"HTTP/HTTPS"| JSFUI

    JSFUI -->|"JSF Managed Beans"| SecurityMod
    JSFUI -->|"JSF Managed Beans"| AuditMod
    JSFUI -->|"JSF Managed Beans"| CoreMod
    JSFUI -->|"JSF Managed Beans"| ProjectMod

    SecurityMod -->|authorize/login| ManagerSecurity
    ManagerSecurity -->|validates DTO| LoginDTO
    SecurityMod -->|serves pages| SecurityUI
    SecurityMod -->|intercepts calls| CoreMod
    SecurityMod -->|intercepts calls| AuditMod

    CoreMod -->|business logic| CoreControllers
    CoreControllers -->|CRUD| ManagerDAO
    ManagerDAO -->|persist/load| DB

    ProjectMod -->|business logic| BeanProject
    BeanProject -->|CRUD| ManagerPry
    ManagerPry -->|persist/load| DB

    RestMod -->|REST calls| HelloApp
    HelloApp -->|CRUD| ManagerDAO

    CoreMod -->|"audit events"| ManagerAudit
    AuditMod -->|"record logs"| BeanAud
    BeanAud -->|persist| DB

    JSFUI -->|"REST calls"| RestMod

    SecurityMod -->|"auth request"| IdentityProv
    Sponsor -->|"coupon validation"| SponsorSys
    ManagerSecurity -->|"issue token"| JWTIssuer
    DB -->|"hosted on"| CloudDB

    %% Styles
    classDef frontend fill:#D0E6FF,stroke:#3B83BD,color:#000;
    classDef service fill:#D8F5D8,stroke:#28A028,color:#000;
    classDef data fill:#FFE4B5,stroke:#E69138,color:#000;
    classDef external fill:#F0F0F0,stroke:#AAAAAA,color:#000;
```
