# tales06/memori architecture

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

- Interactive diagram: https://gitdiagram.com/tales06/memori
- Repository: https://github.com/tales06/memori

## Overview

##### Project Type and Purpose
- Memori is a single-module Android application built with Kotlin and Jetpack Compose. It follows a full-stack mobile pattern where the “frontend” (UI) lives in the app itself and “backend” components are a mix of local persistence (Room, DataStore) and cloud services (Firebase Auth & Firestore). Its core purpose is offline note taking and organization, with optional PIN-protected folders and bidirectional cloud sync.

##### File Structure Analysis
- Top-level “app” module containing:
- src/main/java/com/example/memori → code organized by feature (animation, auth, composable, data, database, preference, routes, setup, sync, theme, ui)
- build.gradle.kts + google-services.json → Gradle config and Firebase setup
- MVVM is enforced via separate ViewModel, Repository, DAO, and Composable directories.
- Configuration: AndroidManifest.xml, Proguard rules, DataStore pref files, Firestore and Auth credentials.

##### Architecture Overview from README
- UI (Jetpack Compose) observes StateFlow/Flow from ViewModels.
- ViewModels delegate data operations to Repositories or directly to Room DAOs/DataStore.
- Repositories encapsulate local Room Database (NoteDatabase + DAOs) and cloud Firestore interactions.
- Firebase Authentication (GoogleAuthClient) manages sign-in; DataStore holds hashed PIN and user preferences.

##### Main Components
a. Frontend/UI Layer
- Jetpack Compose Screens (HomeScreen, NoteCard, FavoritesScreen, PinSetupScreen, etc.)
- NavigationApp component managing Compose Navigation
b. ViewModel Layer
- NoteViewModel, FolderViewModel, SignInViewModel, ThemeViewModel, etc.
c. Data Layer
- Local: Room Database (NoteDatabase, NotesDao, FoldersDao), Jetpack DataStore for PIN & preferences
- Cloud: FirestoreNoteRepository, FirestoreFolderRepository, GoogleAuthClient
d. External Services
- Firebase Authentication service
- Cloud Firestore service
e. Assets & Config
- Local JSON (assets/data.json) for initial data or AI integration
- google-services.json, backup_rules.xml, data_extraction_rules.xml

##### Relationships and Data Flows
- UI → ViewModel: user actions (e.g., “create note”) trigger ViewModel functions
- ViewModel → Repository/DAO: ViewModel decides local vs. cloud path
- Repository → Room: synchronous CRUD via DAO
- Repository → Firestore: asynchronous sync when online
- Firestore ↔ Room: bidirectional sync at startup and on data change
- ViewModel → DataStore: read/write PIN and theme preferences
- SignInViewModel → GoogleAuthClient → Firebase Auth → enables Firestore access

##### Architectural Patterns & Principles
- MVVM divides concerns clearly: composable UI, stateful ViewModels, pure data Repositories
- Single-source-of-truth in Room database; cloud sync augments local data
- Dependency inversion via constructor injection (ViewModels get Repositories)
- Reactive state management with Flow/StateFlow for UI updates

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        NavigationApp["NavigationApp"]:::ui
        HomeScreen["HomeScreen"]:::ui
        NoteCard["NoteCard"]:::ui
        FavoritesScreen["FavoritesScreen"]:::ui
        PinSetupScreen["PinSetupScreen"]:::ui
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        NoteViewModel["NoteViewModel"]:::vm
        FolderViewModel["FolderViewModel"]:::vm
        SignInViewModel["SignInViewModel"]:::vm
        ThemeViewModel["ThemeViewModel"]:::vm
    end

    %% Local Persistence
    subgraph "Local Persistence" 
        direction TB
        NoteRepository["NotesRepository"]:::local
        FolderRepository["FolderRepository"]:::local
        NoteDatabase[(NoteDatabase)]:::local
        NoteDao["NoteDao"]:::local
        FoldersDao["FoldersDao"]:::local
        PinPreferences["PinPreferences"]:::local
        ThemePreferences["ThemePreferences"]:::local
    end

    %% Cloud Sync Repositories
    subgraph "Cloud Sync"
        direction TB
        FirestoreNoteRepository["FirestoreNoteRepository"]:::cloud
        FirestoreFolderRepository["FirestoreFolderRepository"]:::cloud
    end

    %% External Services
    subgraph "External Services"
        direction TB
        FirebaseAuth["Firebase Authentication"]:::cloud
        CloudFirestore[(Cloud Firestore)]:::cloud
    end

    %% Connections UI to ViewModel
    NavigationApp -->|"navigate"| HomeScreen
    HomeScreen -->|"createNote()"| NoteViewModel
    FavoritesScreen -->|"toggleFavorite()"| NoteViewModel
    PinSetupScreen -->|"setPin()"| ThemeViewModel
    HomeScreen -->|"openFolder()"| FolderViewModel
    NavigationApp -->|"signIn()"| SignInViewModel

    %% ViewModel to Repositories/DAOs
    NoteViewModel -->|"getNotes()"| NoteRepository
    NoteViewModel -->|"saveNote()"| NoteRepository
    FolderViewModel -->|"getFolders()"| FolderRepository
    SignInViewModel -->|"signInWithGoogle()"| GoogleAuthClient
    ThemeViewModel -->|"loadTheme()"| ThemePreferences
    ThemeViewModel -->|"saveTheme()"| ThemePreferences

    %% Repository to Local DB
    NoteRepository -->|"queryNotes()"| NoteDao
    NoteRepository -->|"insertNote()"| NoteDao
    FolderRepository -->|"queryFolders()"| FoldersDao
    FolderRepository -->|"insertFolder()"| FoldersDao
    NoteDao --> NoteDatabase
    FoldersDao --> NoteDatabase

    %% Repository to Cloud
    NoteRepository -->|"syncNotes()"| FirestoreNoteRepository
    FolderRepository -->|"syncFolders()"| FirestoreFolderRepository

    %% Cloud Sync bidirectional
    FirestoreNoteRepository -->|"pushNotes()"| CloudFirestore
    FirestoreNoteRepository -->|"pullNotes()"| CloudFirestore
    FirestoreFolderRepository -->|"pushFolders()"| CloudFirestore
    FirestoreFolderRepository -->|"pullFolders()"| CloudFirestore

    %% Auth flow
    SignInViewModel -->|"authRequest()"| FirebaseAuth
    FirebaseAuth -->|"authResult()"| SignInViewModel
    SignInViewModel -->|"provideToken()"| CloudFirestore

    %% Preferences DataStore
    SignInViewModel -->|"savePin()"| PinPreferences

    %% Click Events
    click HomeScreen "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/composable/HomeScreen.kt"
    click NoteCard "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/composable/NoteCard.kt"
    click FavoritesScreen "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/composable/FavoritesScreen.kt"
    click PinSetupScreen "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/composable/PinSetupScreen.kt"
    click NavigationApp "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/routes/NavigationApp.kt"
    click NoteViewModel "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/note_data/NoteViewModel.kt"
    click FolderViewModel "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/folder_data/FolderViewModel.kt"
    click SignInViewModel "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/auth/SignInViewModel.kt"
    click ThemeViewModel "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/theme_data/ThemeViewModel.kt"
    click NoteDatabase "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/NoteDatabase.kt"
    click NoteDao "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/note_data/NoteDao.kt"
    click FoldersDao "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/folder_data/FoldersDao.kt"
    click NoteRepository "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/note_data/NotesRepository.kt"
    click FolderRepository "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/database/folder_data/FolderRepository.kt"
    click PinPreferences "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/preference/PinPreferences.kt"
    click ThemePreferences "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/preference/ThemePreferences.kt"
    click FirestoreNoteRepository "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/sync/FirestoreNoteRepository.kt"
    click FirestoreFolderRepository "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/sync/FirestoreFolderRepository.kt"
    click GoogleAuthClient "https://github.com/tales06/memori/blob/master/app/src/main/java/com/example/memori/auth/GoogleAuthClient.kt"
    click InitialData "https://github.com/tales06/memori/blob/master/app/src/main/assets/data.json"
    click FirebaseAuth "https://github.com/tales06/memori/blob/master/app/google-services.json"
    click BackupRules "https://github.com/tales06/memori/blob/master/app/src/main/res/xml/backup_rules.xml"
    click DataExtraction "https://github.com/tales06/memori/blob/master/app/src/main/res/xml/data_extraction_rules.xml"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#1E90FF,color:#000
    classDef vm fill:#E2F5D9,stroke:#32CD32,color:#000
    classDef local fill:#FFE5B4,stroke:#FFA500,color:#000
    classDef cloud fill:#E6E6FA,stroke:#9370DB,color:#000
```
