# roohi31/android_notetaking_app architecture

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

- Interactive diagram: https://gitdiagram.com/roohi31/android_notetaking_app
- Repository: https://github.com/roohi31/android_notetaking_app

## Overview

##### Project type and purpose
- This is a native Android mobile application written in Kotlin.
- Purpose: A simple note-taking app that demonstrates the MVVM pattern with Room for local data persistence, allowing users to create, view, update, and delete notes.

##### File structure
- Top-level files:
- AndroidManifest.xml (app configuration)
- build scripts (gradle-wrapper.properties, .gitignore)
- Source code under main/java/me/sabapro/udemy_notetaking_app:
- adapter/NoteAdapter.kt
- database/NoteDAO.kt, NoteDatabase.kt
- fragments/HomeFragment.kt, NewNoteFragment.kt, UpdateNoteFragment.kt
- model/Note.kt
- repository/NoteRepository.kt
- viewmodel/NoteViewModel.kt, NoteViewModelFactory.kt
- MainActivity.kt
- Resources under main/res:
- layouts for activity and fragments
- navigation/nav_graph.xml
- menus
- XML rules for backup & data extraction

##### README for additional insights
- Confirms MVVM architecture: ViewModel + LiveData for UI data, Repository for data abstraction, Room for local DB.
- Key technologies: Kotlin, Room Database, Coroutines, RecyclerView.

##### Elements
- Clear labels for each component
- ViewModel layer in another (e.g., green)
- Data layer (Repository/DAO/Database) in a third (e.g., orange)

##### Detailed component breakdown
- UI Layer:
[MainActivity]
↓ hosts
[HomeFragment] ← displays list ← NoteAdapter
[NewNoteFragment] ← form → ViewModel
[UpdateNoteFragment]
- ViewModel Layer:
[NoteViewModel] ← Factory
- exposes LiveData<List<Note>>
- Data Layer:
[NoteRepository]
↕
[NoteDAO] → CRUD on
[NoteDatabase (Room)]
- Model:
[Note Entity]

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MainActivity["MainActivity"]:::frontend
        HomeFragment["HomeFragment"]:::frontend
        NewNoteFragment["NewNoteFragment"]:::frontend
        UpdateNoteFragment["UpdateNoteFragment"]:::frontend
        NoteAdapter["NoteAdapter"]:::frontend
        NavGraph["Navigation Graph"]:::nav
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        NoteViewModelFactory["NoteViewModelFactory"]:::vm
        NoteViewModel["NoteViewModel"]:::vm
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        NoteRepository["NoteRepository"]:::data
        NoteDAO["NoteDAO"]:::data
        NoteDatabase["NoteDatabase (Room)"]:::data
    end

    %% Model
    subgraph "Model"
        direction TB
        NoteEntity["Note Entity"]:::model
    end

    %% Connections
    MainActivity -->|"hosts"| HomeFragment
    MainActivity -->|"hosts"| NewNoteFragment
    MainActivity -->|"hosts"| UpdateNoteFragment

    HomeFragment -->|"uses adapter"| NoteAdapter
    HomeFragment -->|"navigates via"| NavGraph
    NewNoteFragment -->|"navigates via"| NavGraph
    UpdateNoteFragment -->|"navigates via"| NavGraph

    HomeFragment -->|"observes LiveData"| NoteViewModel
    NewNoteFragment -->|"calls ViewModel"| NoteViewModel
    UpdateNoteFragment -->|"calls ViewModel"| NoteViewModel

    NoteViewModelFactory -->|"creates"| NoteViewModel

    NoteViewModel -->|"uses Coroutines"| NoteRepository
    NoteRepository -->|"delegates to"| NoteDAO
    NoteDAO -->|"performs CRUD on"| NoteDatabase

    NoteDatabase -->|"returns data/event"| NoteDAO
    NoteDAO -->|"returns LiveData/List<Note>"| NoteViewModel
    NoteViewModel -->|"exposes LiveData"| HomeFragment

    NoteAdapter -->|"renders"| NoteEntity
    NoteRepository -->|"manages"| NoteEntity

    %% Click Events
    click MainActivity "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/MainActivity.kt"
    click HomeFragment "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/fragments/HomeFragment.kt"
    click NewNoteFragment "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/fragments/NewNoteFragment.kt"
    click UpdateNoteFragment "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/fragments/UpdateNoteFragment.kt"
    click NoteAdapter "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/adapter/NoteAdapter.kt"
    click NoteViewModel "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/viewmodel/NoteViewModel.kt"
    click NoteViewModelFactory "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/viewmodel/NoteViewModelFactory.kt"
    click NoteRepository "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/repository/NoteRepository.kt"
    click NoteDAO "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/database/NoteDAO.kt"
    click NoteDatabase "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/database/NoteDatabase.kt"
    click NoteEntity "https://github.com/roohi31/android_notetaking_app/blob/main/main/java/me/sabapro/udemy_notetaking_app/model/Note.kt"
    click NavGraph "https://github.com/roohi31/android_notetaking_app/blob/main/main/res/navigation/nav_graph.xml"

    %% Styles
    classDef frontend fill:#D6EAF8,stroke:#3498DB
    classDef vm fill:#D5F5E3,stroke:#27AE60
    classDef data fill:#FCF3CF,stroke:#F1C40F
    classDef model fill:#F5EEF8,stroke:#8E44AD
    classDef nav fill:#E5E8E8,stroke:#95A5A6
```
