# aryan-r-patel/safety-planning-app architecture

> Architecture diagram of the GitHub repository aryan-r-patel/safety-planning-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aryan-r-patel/safety-planning-app
- Repository: https://github.com/aryan-r-patel/safety-planning-app

## Overview

##### Project type and purpose
- This is a native Android mobile application (“app” module) whose goal is to help users assess, plan, and manage safety around abusive relationships.
- It uses an MVP-like pattern (e.g., LoginActivityModel/Presenter/View), Android Architecture Components (WorkManager for reminders), local JSON assets, and external services (Firebase Auth & Google Sign-In).

##### File structure
- Top-level “app” module contains:
- src/main/java/com/example/b07demosummer2024: Activities, Fragments, domain models, adapters, presenters, utilities
- src/main/assets: static JSON files (city_resources.json, questions_and_tips.json)
- src/main/res: UI layouts, drawables, menus, values
- src/androidTest & src/test: instrumentation and unit tests
- Key config/build files: build.gradle.kts, google-services.json (Firebase), ProGuard rules, Gradle wrapper.
- Notice use of WorkManager (ReminderWorker), PinManager for local PIN, JSONUtility for parsing assets.

##### README for architectural clues
- Describes features: authentication (email/password & Google), PIN setup, questionnaire → plan generation, support resources, item storage, reminders, quick-exit.
- Mentions Firebase for auth and Realtime Database security.
- Contributors map roughly to feature implementation modules.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        LoginActivity["LoginActivity"]:::ui
        PinSetupActivity["PinSetupActivity"]:::ui
        PinLoginActivity["PinLoginActivity"]:::ui
        MainActivity["MainActivity"]:::ui
        HomeFragment["HomeFragment"]:::ui
        QuestionnaireFragment["QuestionnaireFragment"]:::ui
        PlanFragment["PlanFragment"]:::ui
        SupportFragment["SupportFragment"]:::ui
        RemindersFragment["RemindersFragment"]:::ui
        RecyclerViewFragment["RecyclerViewFragment"]:::ui
        RecyclerViewStaticFragment["RecyclerViewStaticFragment"]:::ui
        AddItemFragment["AddItemFragment"]:::ui
        EditItemFragment["EditItemFragment"]:::ui
        DeleteItemFragment["DeleteItemFragment"]:::ui
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        LoginPresenter["LoginActivityPresenter"]:::presenter
        LoginModel["LoginActivityModel"]:::presenter
        LoginView["LoginActivityView"]:::presenter
    end

    %% Data Layer
    subgraph "Domain / Data Layer"
        direction TB
        ItemModel["Item"]:::model
        PlanItemModel["PlanItem"]:::model
        ReminderModel["Reminder"]:::model
        ItemAdapter["ItemAdapter"]:::model
        PlanItemAdapter["PlanItemAdapter"]:::model
        ReminderAdapter["ReminderAdapter"]:::model
        JSONUtility["JSONUtility"]:::service
        PinManager["PinManager"]:::service
        CityJSON["city_resources.json"]:::service
        QuestionsJSON["questions_and_tips.json"]:::service
    end

    %% Background Services
    subgraph "Background Services"
        direction TB
        ReminderScheduler["ReminderScheduler"]:::service
        ReminderWorker["ReminderWorker"]:::service
    end

    %% External Services
    subgraph "External Services"
        direction TB
        FirebaseAuth["Firebase Authentication"]:::external
        RealtimeDB["Firebase Realtime Database"]:::external
        GoogleSignIn["Google Sign-In"]:::external
        Chrome["Chrome Browser (Quick-Exit)"]:::external
    end

    %% Android OS Services
    subgraph "Android OS Services"
        direction TB
        WorkManagerOS["WorkManager"]:::os
        NotificationOS["Notifications"]:::os
        AssetsOS["Assets"]:::os
    end

    %% Relationships
    LoginActivity -->|uses| LoginPresenter
    LoginPresenter -->|calls| LoginModel
    LoginPresenter -->|updates| LoginView
    LoginModel -->|auth| FirebaseAuth
    LoginPresenter -->|auth| GoogleSignIn

    PinSetupActivity -->|stores| PinManager
    PinLoginActivity -->|validates| PinManager

    QuestionnaireFragment -->|loads| JSONUtility
    JSONUtility -->|reads| CityJSON
    JSONUtility -->|reads| QuestionsJSON
    QuestionnaireFragment -->|navigates to| PlanFragment

    PlanFragment -->|binds| PlanItemAdapter
    HomeFragment -->|binds| ItemAdapter
    RemindersFragment -->|binds| ReminderAdapter

    AddItemFragment -->|creates| ItemModel
    EditItemFragment -->|updates| ItemModel
    DeleteItemFragment -->|deletes| ItemModel

    ReminderScheduler -->|schedules| WorkManagerOS
    WorkManagerOS -->|runs| ReminderWorker
    ReminderWorker -->|triggers| NotificationOS

    MainActivity -->|hosts| HomeFragment
    MainActivity -->|hosts| QuestionnaireFragment
    MainActivity -->|hosts| PlanFragment
    MainActivity -->|hosts| SupportFragment
    MainActivity -->|hosts| RemindersFragment
    MainActivity -->|hosts| RecyclerViewFragment
    MainActivity -->|hosts| RecyclerViewStaticFragment

    LoginActivity -->|navigates to| PinSetupActivity
    LoginActivity -->|navigates to| PinLoginActivity

    SupportFragment -->|opens| Chrome

    %% Click Events
    click LoginActivityModel "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/LoginActivityModel.java"
    click LoginActivityPresenter "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/LoginActivityPresenter.java"
    click LoginActivityView "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/LoginActivityView.java"
    click PinSetupActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PinSetupActivity.java"
    click PinLoginActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PinLoginActivity.java"
    click PinManager "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PinManager.java"
    click MainActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/MainActivity.java"
    click BaseActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/BaseActivity.java"
    click HomeFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/HomeFragment.java"
    click QuestionnaireFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/QuestionnaireFragment.java"
    click PlanFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PlanFragment.java"
    click SupportFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/SupportFragment.java"
    click RemindersFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/RemindersFragment.java"
    click RecyclerViewFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/RecyclerViewFragment.java"
    click RecyclerViewStaticFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/RecyclerViewStaticFragment.java"
    click AddItemFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/AddItemFragment.java"
    click EditItemFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/EditItemFragment.java"
    click DeleteItemFragment "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/DeleteItemFragment.java"
    click ItemModel "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/Item.java"
    click PlanItemModel "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PlanItem.java"
    click ReminderModel "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/Reminder.java"
    click ItemAdapter "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/ItemAdapter.java"
    click PlanItemAdapter "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/PlanItemAdapter.java"
    click ReminderAdapter "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/ReminderAdapter.java"
    click JSONUtility "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/JSONUtility.java"
    click CityJSON "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/assets/city_resources.json"
    click QuestionsJSON "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/assets/questions_and_tips.json"
    click ReminderScheduler "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/ReminderScheduler.java"
    click ReminderWorker "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/java/com/example/b07demosummer2024/ReminderWorker.java"
    click GoogleSignIn "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/google-services.json"
    click MainActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/build.gradle.kts"
    click BaseActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/proguard-rules.pro"
    click MainActivity "https://github.com/aryan-r-patel/safety-planning-app/blob/main/app/src/main/AndroidManifest.xml"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#004085;
    classDef presenter fill:#d4edda,stroke:#155724;
    classDef model fill:#fff3cd,stroke:#856404;
    classDef service fill:#d1ecf1,stroke:#0c5460;
    classDef external fill:#f8d7da,stroke:#721c24;
    classDef os fill:#e2e3e5,stroke:#6c757d;
```
