# nisrinelachguer/ai-voicetherapy architecture

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

- Interactive diagram: https://gitdiagram.com/nisrinelachguer/ai-voicetherapy
- Repository: https://github.com/nisrinelachguer/ai-voicetherapy

## Overview

##### Project type and purpose
- This is a full-stack, three-tier application for automated voice rehabilitation.
- Presentation Layer: Android mobile app (Java, Material Design, Retrofit)
- Business Logic Layer: Spring Boot REST API (controllers, services, JWT security)
- Data Layer: MySQL (JPA/Hibernate) + file storage for audio

##### File structure
- Frontend (Android)
- app/src/main/java/com/lachguer/ai_voice/ui → Activities & Fragments (UI controllers)
- app/src/main/java/com/lachguer/ai_voice/api → Retrofit ApiService & ApiClient
- app/src/main/java/com/lachguer/ai_voice/model → DTOs and domain models (User, VoiceAnalysis, TherapyExercise)
- app/src/main/java/com/lachguer/ai_voice/utils → AudioConverter, SessionManager (helper classes)
- Resources (layouts, drawables, themes) and Gradle build scripts
- ai_voice (Spring Boot)
- controller → AuthController, VoiceAnalysisController, TherapyExerciseController, UserController
- service → AuthService, VoiceAnalysisService, OpenAIService, TherapyExerciseService, OpenAIConfig
- security → JwtAuthenticationFilter, SecurityConfig, JwtService, UserDetailsServiceImpl
- repository → JPA repositories for User, VoiceAnalysis, TherapyExercise
- dto → Request/Response classes paralleling frontend models
- model → JPA entities
- application.properties and Maven POM
- uploads/audio → persisted audio files awaiting or post-analysis

##### README for additional insights
- Confirms three-tier architecture and tech stack (Android SDK, Spring Boot, MySQL, JWT, OpenAI Whisper)
- Describes user flow: Registration → Recording → Analysis via Whisper API → Results → Therapy exercises
- Highlights AI integration (speech-to-text, pattern analysis, severity scoring, exercise generation)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Presentation Layer (Mobile App)"
        UI["Activities & Fragments"]:::mobile
        Retrofit["Retrofit ApiClient & ApiService"]:::mobile
        Models["DTOs & Domain Models"]:::mobile
        Utils["AudioConverter & SessionManager"]:::mobile
    end

    subgraph "Business Logic Layer (Spring Boot API)"
        JwtFilter["JwtAuthenticationFilter"]:::backend
        AuthController["AuthController"]:::backend
        VAController["VoiceAnalysisController"]:::backend
        TEController["TherapyExerciseController"]:::backend
        UserController["UserController"]:::backend
        AuthService["AuthService"]:::backend
        VAService["VoiceAnalysisService"]:::backend
        OpenAIService["OpenAIService"]:::backend
        TEService["TherapyExerciseService"]:::backend
        OpenAIConfig["OpenAIConfig"]:::backend
        AppMain["AiVoiceApplication"]:::backend
    end

    subgraph "Security Components"
        JwtService["JwtService"]:::backend
        SecurityConfig["SecurityConfig"]:::backend
        UserDetails["UserDetailsServiceImpl"]:::backend
    end

    subgraph "Data Access Layer"
        UserRepo["UserRepository"]:::backend
        VARepo["VoiceAnalysisRepository"]:::backend
        TERepo["TherapyExerciseRepository"]:::backend
    end

    subgraph "Data Layer"
        DB["MySQL Database"]:::db
        FS["File Storage (uploads/audio)"]:::db
    end

    ExternalAI["OpenAI Whisper API"]:::external

    %% Relationships
    UI -->|records audio| Utils
    Utils -->|converts audio| Retrofit
    Retrofit -->|HTTP POST /auth/login| AuthController
    Retrofit -->|HTTP POST /voice/analyze| VAController
    AuthController -->|calls| AuthService
    VAController -->|calls| VAService
    TEController -->|calls| TEService
    UserController -->|calls| AuthService
    JwtFilter -->|filters requests| AuthController
    AuthService -->|uses| JwtService
    VAService -->|uses| OpenAIService
    OpenAIService -->|calls| ExternalAI
    VAService -->|saves analysis| VARepo
    TEService -->|generates & saves exercises| TERepo
    AuthService -->|saves user| UserRepo
    VARepo -->|persists| DB
    TERepo -->|persists| DB
    UserRepo -->|persists| DB
    VAService -->|stores audio| FS

    %% Click Events - Mobile
    click UI "https://github.com/nisrinelachguer/ai-voicetherapy/tree/main/Frontend/app/src/main/java/com/lachguer/ai_voice/ui"
    click Retrofit "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/Frontend/app/src/main/java/com/lachguer/ai_voice/api/ApiClient.java"
    click Retrofit "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/Frontend/app/src/main/java/com/lachguer/ai_voice/api/ApiService.java"
    click Models "https://github.com/nisrinelachguer/ai-voicetherapy/tree/main/Frontend/app/src/main/java/com/lachguer/ai_voice/model"
    click Utils "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/Frontend/app/src/main/java/com/lachguer/ai_voice/utils/AudioConverter.java"
    click Utils "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/Frontend/app/src/main/java/com/lachguer/ai_voice/utils/SessionManager.java"

    %% Click Events - Backend
    click AppMain "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/AiVoiceApplication.java"
    click AuthController "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/controller/AuthController.java"
    click VAController "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/controller/VoiceAnalysisController.java"
    click TEController "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/controller/TherapyExerciseController.java"
    click UserController "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/controller/UserController.java"
    click AuthService "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/service/AuthService.java"
    click VAService "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/service/VoiceAnalysisService.java"
    click OpenAIService "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/service/OpenAIService.java"
    click TEService "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/service/TherapyExerciseService.java"
    click OpenAIConfig "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/service/OpenAIConfig.java"
    click JwtFilter "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/security/JwtAuthenticationFilter.java"
    click JwtService "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/security/JwtService.java"
    click SecurityConfig "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/security/SecurityConfig.java"
    click UserDetails "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/security/UserDetailsServiceImpl.java"
    click UserRepo "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/repository/UserRepository.java"
    click VARepo "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/repository/VoiceAnalysisRepository.java"
    click TERepo "https://github.com/nisrinelachguer/ai-voicetherapy/blob/main/ai_voice/src/main/java/aivoice/mobile/project/ai_voice/repository/TherapyExerciseRepository.java"

    %% Styles
    classDef mobile fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef external fill:#ffe5b4,stroke:#cc8400,color:#cc8400
    classDef db fill:#e2e3e5,stroke:#6c757d,color:#6c757d
```
