# script-eng/mentorconnect architecture

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

- Interactive diagram: https://gitdiagram.com/script-eng/mentorconnect
- Repository: https://github.com/script-eng/mentorconnect

## Overview

##### Project type and purpose
- MentorConnect is a native Android mobile application (Java) designed to help new university students navigate paperwork, locate administrative offices, and connect with mentors via chat.
- It follows a Single-Activity architecture hosting multiple Fragments, uses Firebase (or REST) for real-time data, Room for offline caching, and Google Maps for navigation.

##### File structure
- Top-level “app/” module contains build scripts, AndroidManifest, resources, and source code.
- activities/ (MainActivity, LoginActivity, MentorHomeActivity, etc.)
- fragments/ (ChatFragment, DocsFragment, HomeFragment, MapFragment, MentorFragment)
- adapters/ (RecyclerView adapters for chat, documents, mentors, messages)
- models/ (Mentor, Message, Document, LocationInfo)
- receivers/ (DownloadCompletionReceiver for file downloads)
- No explicit ViewModel folder, but there is a repository/ or network/ folder in the README sample—likely a data layer.
- Resources: layouts, drawables, menus, XML rules.
- Config files: `google-services.json`, ProGuard rules, Gradle wrappers.

##### README for additional insights
- Architecture: Single Activity + Fragments
- Networking: Firebase Firestore or Retrofit/Volley
- Local Storage: Room Database
- Media & Maps: Glide, Google Maps API

## Diagram (Mermaid)

```mermaid
flowchart TD
  subgraph "UI Layer"
    MA["MainActivity"]:::ui
    LA["LoginActivity"]:::ui
    LIA["LoginIntroActivity"]:::ui
    RGA["RegisterActivity"]:::ui
    MHA["MentorHomeActivity"]:::ui
    subgraph "Fragments"
      CF["ChatFragment"]:::ui
      DoF["DocsFragment"]:::ui
      HF["HomeFragment"]:::ui
      MF["MapFragment"]:::ui
      MenF["MentorFragment"]:::ui
    end
    subgraph "Adapters"
      CAd["ChatAdapter"]:::ui
      DAd["DocumentAdapter"]:::ui
      MAd["MentorAdapter"]:::ui
      MsgAd["MessageAdapter"]:::ui
    end
  end

  subgraph "Data Layer"
    Repo["Repository"]:::data
    Net["Network Module"]:::data
    DB["Room Database"]:::data
  end

  subgraph "Domain Models"
    Mentor["Mentor"]:::model
    Message["Message"]:::model
    Document["Document"]:::model
    LocInfo["LocationInfo"]:::model
  end

  subgraph "System Receivers"
    DCR["DownloadCompletionReceiver"]:::sys
  end

  subgraph "External Services"
    FS["Firebase Firestore"]:::external
    GM["Google Maps API"]:::external
  end

  %% UI hosting and interactions
  MA -->|hosts| HF
  MA -->|hosts| CF
  MA -->|hosts| DoF
  MA -->|hosts| MF
  MA -->|hosts| MenF

  CF -->|"uses"| CAd
  DoF -->|"uses"| DAd
  MenF -->|"uses"| MAd
  CF -->|"uses"| MsgAd

  %% Data flows
  CF -->|"requests data"| Repo
  DoF -->|"requests data"| Repo
  HF -->|"requests data"| Repo
  MF -->|"requests data"| Repo
  MenF -->|"requests data"| Repo

  Repo -->|"fetches online"| Net
  Repo -->|"caches offline"| DB

  %% Models
  Repo --> Mentor
  Repo --> Message
  Repo --> Document
  Repo --> LocInfo

  %% External interactions
  Net -->|"real-time sync"| FS
  CF -. "real-time listeners" .-> FS
  MF -->|"map & directions"| GM

  %% Receiver interactions
  DAd -.->|"download complete event"| DCR

  %% Click Events
  click MA "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/MainActivity.java"
  click LA "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/activities/LoginActivity.java"
  click LIA "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/activities/LoginIntroActivity.java"
  click RGA "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/activities/RegisterActivity.java"
  click MHA "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/activities/MentorHomeActivity.java"
  click CF "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/fragments/ChatFragment.java"
  click DoF "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/fragments/DocsFragment.java"
  click HF "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/fragments/HomeFragment.java"
  click MF "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/fragments/MapFragment.java"
  click MenF "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/fragments/MentorFragment.java"
  click CAd "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/adapters/ChatAdapter.java"
  click DAd "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/adapters/DocumentAdapter.java"
  click MAd "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/adapters/MentorAdapter.java"
  click MsgAd "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/adapters/MessageAdapter.java"
  click Mentor "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/models/Mentor.java"
  click Message "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/models/Message.java"
  click Document "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/models/Document.java"
  click LocInfo "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/models/LocationInfo.java"
  click DCR "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/java/hu/nje/mentorconnect/receivers/DownloadCompletionReceiver.java"
  click FS "https://github.com/script-eng/mentorconnect/blob/main/app/google-services.json"
  click FS "https://github.com/script-eng/mentorconnect/blob/main/app/src/main/AndroidManifest.xml"

  %% Styles
  classDef ui fill:#D0E8FF,stroke:#0066CC,color:#000;
  classDef data fill:#E2F7D4,stroke:#33AA33,color:#000;
  classDef external fill:#FFE5CC,stroke:#FF6600,color:#000;
  classDef model fill:#F0F0F0,stroke:#888888,color:#000;
  classDef sys fill:#F9E79F,stroke:#D68910,color:#000;
```
