# oskarzan/app_finanza architecture

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

- Interactive diagram: https://gitdiagram.com/oskarzan/app_finanza
- Repository: https://github.com/oskarzan/app_finanza

## Overview

Este proyecto es una aplicación Android para la gestión financiera personal, denominada FinanzasZan. Basándonos en el file tree y el README, se puede apreciar que la aplicación utiliza Kotlin, Jetpack Compose, Material Design 3, Room Database, Coroutines y Flow, todo dentro de un enfoque basado en MVVM (Model-View-ViewModel). A continuación, se detallan los pasos y componentes clave para crear un diagrama de arquitectura completo y preciso, ideal para un ingeniero de software principal:

##### Identificación del tipo de proyecto y propósito
- Tipo: Aplicación móvil Android.
- Propósito: Gestión financiera personal, permitiendo al usuario registrar ingresos, gastos, categorizarlos, visualizar balances mensuales y analizar el rendimiento financiero a través de un calendario y vistas de resumen.
- Indicadores: Uso de Room para el manejo de la base de datos, arquitectura MVVM evidente por la separación en paquetes “ui” y “viewmodel”, y un enfoque en componentes modernos de UI (Jetpack Compose).

##### Análisis de la estructura del proyecto
- Directorio "app": Contiene el código fuente principal, dividido en módulos tales como "src/main" para el código de producción y "src/androidTest/src/test" para pruebas.
- Dentro de "src/main":
- Directorio "java/com/example/financeszan": Contiene paquetes organizados en:
- data: Incluye la base de datos (FinancesDatabase.kt), repositorio (TransactionRepository.kt), clases de conversión (Converters.kt) y DAOs (por ejemplo, TransactionDao.kt) – estos representan la capa de datos.
- data/entities: Define las entidades de transacción, categoría y tipo, reflejando el modelo de datos.
- ui: Divide la lógica de interfaz en "screens" (diferentes pantallas como MainScreen, AddTransactionScreen, etc.), "theme" (estilos y temas) y "viewmodel" (gestión del estado y lógica de negocio, representado en clases como FinancesViewModel, CalendarViewModel, etc.).
- Mecanismos de configuración y construcción:
- Archivos de Gradle y configuraciones en "build.gradle.kts" y "settings.gradle.kts" para compilar y gestionar dependencias.

##### Componentes principales a incluir en el diagrama
a. Interfaz de Usuario (UI):
- Pantallas: MainScreen, AddTransactionScreen, CalendarScreen, ProfileScreen, SettingsScreen.
- Temas y recursos: Definidos en el paquete “theme” y en los recursos de Android (res/values, res/drawable, etc.).
b. Lógica de Presentación (ViewModels):
- Varios ViewModels (FinancesViewModel, CalendarViewModel, ProfileViewModel, SettingsViewModel) que gestionan el estado y la lógica de negocio, actuando como intermediarios entre la UI y la capa de datos.
c. Capa de Datos:
- Room Database: FinancesDatabase, junto con Converters para tipos de datos personalizados.
- Repositorio: TransactionRepository que encapsula la lógica de acceso a datos.
- DAO: TransactionDao para interacción directa con la base de datos.
- Entidades: Transaction, TransactionCategory, TransactionType.
d. Pruebas:
- Directorios para unit tests e instrumented tests que aseguran la funcionalidad de la aplicación.

##### Relaciones e interacciones entre componentes
- La UI se comunica con los ViewModels para enviar eventos del usuario y solicitar datos.
- Los ViewModels interactúan con el repositorio (TransactionRepository) para obtener y manipular datos.
- El repositorio, a su vez, utiliza Room (accediendo a FinancesDatabase y DAO) para realizar operaciones de almacenamiento local.
- Se pueden resaltar interacciones de datos asincrónicas con Coroutines y Flow.

##### Orientaciones para diseñar el diagrama
a. Utilizar capas para reflejar la arquitectura MVVM:
- Capa de Presentación: Representa las pantallas y componentes de UI.
- Capa de Lógica/Intermediaria: Incluir los ViewModels.
- Capa de Datos: Mostrar el repositorio, DAO, entidades y base de datos Room.
b. Conectar componentes con flechas direccionales que indiquen:
- Flujo de eventos de la UI hacia los ViewModels.
- Transferencia de datos de los ViewModels hacia el repositorio y viceversa.
- La comunicación entre el repositorio y la Base de Datos mediante los DAOs.
c. Incluir notas de tecnologías y frameworks:
- Mencionar el uso de Jetpack Compose en la UI.
- Resaltar el uso de Room para la persistencia de datos y su integración con Coroutines y Flow.
d. Utilizar etiquetas claras para cada componente:
- Etiquetar cada módulo (ej.: “Pantalla Principal”, “ViewModel de Finanzas”, “Repositorio de Transacciones”, “DAO de Transacciones”, “Base de Datos Room”).
- Diferenciar visualmente (por colores o formas) las capas (por ejemplo, rectángulos para componentes UI, óvalos para lógica/intermediaria y cilindros para bases de datos).

##### Consejos adicionales
- Asegúrate de representar las pruebas (unitarias e instrumentadas) en un segmento secundario, para mostrar cobertura integral.
- Teniendo en cuenta la escalabilidad, sugiere que el diagrama incluya potencialmente futuras extensiones (como la integración de servicios de exportación o backup en la nube mencionado en las futuras actualizaciones).
- Mantén el diagrama detallado pero claro, destacando cómo la arquitectura MVVM facilita la separación de preocupaciones y la mantenibilidad de la aplicación.

Con estos lineamientos, el diagrama resultante proporcionará una vista general y detallada de la arquitectura, facilitando la comprensión del flujo de datos y la separación de responsabilidades en FinanzasZan. Es fundamental ser lo más explícito posible, asignando componentes a las capas correctas y utilizando flechas para detallar el flujo de información entre ellos.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Capa de Presentacion (UI)
    subgraph "Capa de Presentacion (UI)"
        UI1["Pantallas (MainScreen, AddTransactionScreen, CalendarScreen, ProfileScreen, SettingsScreen)"]:::ui
        UI2["Temas (Kotlin: Color.kt, Theme.kt, Type.kt)"]:::ui
        UI3["Recursos (XML: colors.xml, strings.xml, themes.xml)"]:::ui
    end

    %% Capa de Lógica/Intermediaria (ViewModels)
    subgraph "Capa de Lógica/Intermediaria (ViewModels)"
        VM["ViewModels (FinancesViewModel, CalendarViewModel, ProfileViewModel, SettingsViewModel)"]:::viewmodel
    end

    %% Capa de Datos
    subgraph "Capa de Datos"
        DB["Room Database (FinancesDatabase)"]:::database
        CONV["Conversores"]:::data
        REPO["Repositorio (TransactionRepository)"]:::data
        DAO["DAO (TransactionDao)"]:::data
        ENT["Entidades (Transaction, TransactionCategory, TransactionType)"]:::data
    end

    %% Pruebas
    subgraph "Pruebas"
        TEST1["Pruebas Instrumentadas"]:::test
        TEST2["Pruebas Unitarias"]:::test
    end

    %% Relaciones entre capas
    UI1 -->|"usa"| VM
    UI2 -->|"usa"| VM
    UI3 -->|"usa"| VM
    VM -->|"invoca"| REPO
    REPO -->|"accede a"| DAO
    REPO -->|"utiliza"| CONV
    DAO -->|"consulta"| DB
    DAO -->|"opera sobre"| ENT

    %% Estilos
    classDef ui fill:#AEDFF7,stroke:#1f78b4,stroke-width:2px;
    classDef viewmodel fill:#FFF2B2,stroke:#E6A01B,stroke-width:2px;
    classDef data fill:#C3F7B5,stroke:#3CB371,stroke-width:2px;
    classDef test fill:#F7B5B5,stroke:#D9534F,stroke-width:2px;
    classDef database fill:#D5E8D4,stroke:#82B366,stroke-width:2px;

    %% Click Events
    click UI1 "https://github.com/oskarzan/app_finanza/tree/master/app/src/main/java/com/example/financeszan/ui/screens"
    click UI2 "https://github.com/oskarzan/app_finanza/tree/master/app/src/main/java/com/example/financeszan/ui/theme"
    click UI3 "https://github.com/oskarzan/app_finanza/tree/master/app/src/main/res/values"
    click VM "https://github.com/oskarzan/app_finanza/tree/master/app/src/main/java/com/example/financeszan/ui/viewmodel"
    click DB "https://github.com/oskarzan/app_finanza/blob/master/app/src/main/java/com/example/financeszan/data/FinancesDatabase.kt"
    click DB "https://github.com/oskarzan/app_finanza/blob/master/app/schemas/com.example.financeszan.data.FinancesDatabase"
    click CONV "https://github.com/oskarzan/app_finanza/blob/master/app/src/main/java/com/example/financeszan/data/Converters.kt"
    click REPO "https://github.com/oskarzan/app_finanza/blob/master/app/src/main/java/com/example/financeszan/data/TransactionRepository.kt"
    click DAO "https://github.com/oskarzan/app_finanza/blob/master/app/src/main/java/com/example/financeszan/data/dao/TransactionDao.kt"
    click ENT "https://github.com/oskarzan/app_finanza/tree/master/app/src/main/java/com/example/financeszan/data/entities"
    click TEST1 "https://github.com/oskarzan/app_finanza/blob/master/app/src/androidTest/java/com/example/financeszan/ExampleInstrumentedTest.kt"
    click TEST2 "https://github.com/oskarzan/app_finanza/blob/master/app/src/test/java/com/example/financeszan/ExampleUnitTest.kt"
```
