# rioacosta/s5-02-virtual-pet-app architecture

> Architecture diagram of the GitHub repository rioacosta/s5-02-virtual-pet-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rioacosta/s5-02-virtual-pet-app
- Repository: https://github.com/rioacosta/s5-02-virtual-pet-app

## Overview

##### Project type and purpose
- This is a monolithic Spring Boot “Virtual Pet” back-end service. It exposes REST APIs for user registration/login, admin functions, and interactions with “virtual buddies” (meditation companions). It persists data to MongoDB, secures endpoints with JWT, and is containerized via Docker.

##### File structure
- Top-level artifacts:
- pom.xml, mvnw(.cmd), .mvn/ … → Maven-based Java build
- Dockerfile + docker-compose.yml → container orchestration (app + MongoDB).
- src/main/java_S502VirtualPetApp/config/… → configuration (data initialization, security, OpenAPI).
- src/main/java_S502VirtualPetApp/controller/… → REST controllers (Auth, User, Buddy, Admin).
- src/.../service/… → business logic.
- src/.../repository/… → Spring Data Mongo repositories.
- src/.../model & dto/… → domain models and data transfer objects.
- src/.../security/… → JWT utilities, filters, encoder.
- Tests mirror main code for unit and integration testing, including TestMongoConfig and TestSecurityConfig.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    Client["Web/Mobile Client"]:::external

    %% Docker Compose Orchestration
    subgraph "Docker Compose" 
        direction TB
        AppContainer["Virtual-Pet-App Container"]:::external
        MongoDB["MongoDB Container"]:::external
    end

    %% Virtual-Pet-App internals
    subgraph "Virtual-Pet-App" 
        direction TB
        Entry["S502MeditationBuddysAppApplication"]:::internal

        subgraph "Configuration Layer"
            direction TB
            DataInit["DataInitializer"]:::config
            MongoCfg["MongoConfig"]:::config
            OpenAPI["OpenApiConfig"]:::config
            SecurityCfg["SecurityConfig"]:::config
        end

        subgraph "Security Filter Chain"
            direction TB
            JwtFilter["JwtAuthFilter"]:::internal
            AuthUtil["AuthUtil"]:::internal
            JwtUtil["JwtUtil"]:::internal
            Encoder["EncoderConfig"]:::internal
        end

        subgraph "Controller Layer"
            direction TB
            AuthCtrl["AuthController"]:::internal
            UserCtrl["UserController"]:::internal
            BuddyCtrl["BuddyController"]:::internal
            AdminCtrl["AdminController"]:::internal
        end

        subgraph "Service Layer"
            direction TB
            UserSvc["UserService"]:::internal
            BuddySvc["BuddyService"]:::internal
            AdminSvc["AdminService"]:::internal
        end

        subgraph "Repository Layer"
            direction TB
            UserRepo["UserRepository"]:::internal
            BuddyRepo["VirtualBuddyRepository"]:::internal
        end

        DTO["DTO Layer"]:::annotation
    end

    %% Logging Sink
    Logs["Application Logs"]:::external

    %% Connections
    Client -->|HTTPS Request| AppContainer
    AppContainer -->|starts| Entry
    Entry -->|init| DataInit
    Entry -->|load config| MongoCfg
    Entry -->|load config| OpenAPI
    Entry -->|load config| SecurityCfg
    SecurityCfg -->|configure filter| JwtFilter
    JwtFilter -->|uses| AuthUtil
    JwtFilter -->|uses| JwtUtil
    JwtFilter -->|uses| Encoder

    Client -->|JWT Token| JwtFilter
    JwtFilter -->|authorize| AuthCtrl
    AuthCtrl -->|calls| UserSvc
    AuthCtrl -->|calls| BuddySvc

    UserCtrl -->|calls| UserSvc
    BuddyCtrl -->|calls| BuddySvc
    AdminCtrl -->|calls| AdminSvc

    UserSvc -->|uses| UserRepo
    BuddySvc -->|uses| BuddyRepo
    AdminSvc -->|uses| UserRepo
    AdminSvc -->|uses| BuddyRepo

    UserRepo -->|persist/retrieve| MongoDB
    BuddyRepo -->|persist/retrieve| MongoDB
    DataInit -->|seed data| MongoDB
    OpenAPI -->|expose Swagger UI| Client

    AppContainer -->|write logs| Logs

    %% Click Events
    click JwtFilter "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/security/JwtAuthFilter.java"
    click AuthUtil "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/security/AuthUtil.java"
    click JwtUtil "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/security/JwtUtil.java"
    click Encoder "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/security/EncoderConfig.java"
    click SecurityCfg "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/config/SecurityConfig.java"
    click AuthCtrl "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/controller/AuthController.java"
    click UserCtrl "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/controller/UserController.java"
    click BuddyCtrl "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/controller/BuddyController.java"
    click AdminCtrl "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/controller/AdminController.java"
    click UserSvc "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/service/UserService.java"
    click BuddySvc "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/service/BuddyService.java"
    click AdminSvc "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/service/AdminService.java"
    click UserRepo "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/repository/UserRepository.java"
    click BuddyRepo "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/repository/VirtualBuddyRepository.java"
    click DataInit "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/config/DataInitializer.java"
    click MongoCfg "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/config/MongoConfig.java"
    click OpenAPI "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/config/OpenApiConfig.java"
    click Entry "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/src/main/java/S502VirtualPetApp/S502MeditationBuddysAppApplication.java"
    click AppContainer "https://github.com/rioacosta/s5-02-virtual-pet-app/tree/master/Dockerfile"
    click AppContainer "https://github.com/rioacosta/s5-02-virtual-pet-app/blob/master/docker-compose.yml"
    classDef internal fill:#aaddff,stroke:#333,stroke-width:1px
    classDef external fill:#aaffaa,stroke:#333,stroke-width:1px
    classDef config fill:#ffd8b1,stroke:#333,stroke-width:1px
    classDef annotation fill:none,stroke-dasharray: 2 2,stroke:#999,stroke-width:1px
```
