# thisaakash/aadhantermwork architecture

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

- Interactive diagram: https://gitdiagram.com/thisaakash/aadhantermwork
- Repository: https://github.com/thisaakash/aadhantermwork

## Overview

##### Project Type and Purpose
- This is a native Android mobile application (“app” module) for managing Companies and Students, handling user login, displaying data on maps, and sending/receiving notifications via Firebase Cloud Messaging (FCM).

##### High‑Level Architectural Components
a. UI Layer
- Activities (e.g., LoginActivity, MainActivity, AddCompanyActivity)
- Fragments (e.g., HomeFragment, MapFragment, NotificationFragment, ProfileFragment)
- Adapters & View Holders (e.g., CompanyAdapter, StudentAdapter)
b. Domain/Model Layer
- Data classes in `model` package (Company, Student, LoginRequest/Response, NotificationRequest)
c. Network/API Layer
- Retrofit interfaces in `api` package (AadhanApi, NotificationApi)
- HTTP client configuration (likely in AadhanApplication or a DI module)
d. Firebase Messaging Service
- `MyFirebaseMessagingService` handles inbound FCM pushes
e. Persistence (optional/local caches)
- SharedPreferences or SQLite – not explicit, but could be present for session tokens
f. Build & Configuration
- Gradle scripts (root & `app/build.gradle`)
- google‑services.json for Firebase config

##### External Dependencies & Services
- Firebase Cloud Messaging (push notifications)
- Backend REST APIs (endpoints consumed by AadhanApi & NotificationApi)
- Google Maps SDK (used in MapFragment + custom markers)

##### Relationships & Data Flows
- User taps UI → Activity/Fragment invokes Network Layer → HTTP calls to backend
- Backend → sends data (Companies, Students, Auth token) → displayed by UI
- Admin screens → POST/PUT calls via AadhanApi to create/update entities
- Notification flow:
– App registers FCM token via NotificationApi
– Backend pushes notifications via FCM → MyFirebaseMessagingService receives → triggers NotificationFragment updates

##### Architectural Patterns & Principles
- Layered architecture: clear separation of UI, domain, and networking
- Single Activity / multiple Fragments pattern in MainActivity
- Adapter pattern for lists (RecyclerView Adapters)
- Use of Intent‑Service (`MyFirebaseMessagingService`) for background message handling

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Android App"
    subgraph "UI Layer"
      LoginActivity["LoginActivity"]:::ui
      MainActivity["MainActivity"]:::ui
      AddCompanyActivity["AddCompanyActivity"]:::ui
      AddStudentActivity["AddStudentActivity"]:::ui
      AdminActivity["AdminActivity"]:::ui
      CompanyDetailActivity["CompanyDetailActivity"]:::ui
      EditCompanyActivity["EditCompanyActivity"]:::ui
      EditStudentActivity["EditStudentActivity"]:::ui
      InfoActivity["InfoActivity"]:::ui
      SendNotificationActivity["SendNotificationActivity"]:::ui
      SplashActivity["SplashActivity"]:::ui

      HomeFragment["HomeFragment"]:::ui
      MapFragment["MapFragment"]:::ui
      NotificationFragment["NotificationFragment"]:::ui
      ProfileFragment["ProfileFragment"]:::ui

      CompanyAdapter["CompanyAdapter"]:::ui
      StudentAdapter["StudentAdapter"]:::ui
      EditCompanyAdapter["EditCompanyAdapter"]:::ui
      EditStudentAdapter["EditStudentAdapter"]:::ui
      CustomInfoWindowAdapter["CustomInfoWindowAdapter"]:::ui
      BitmapHelper["BitmapHelper"]:::ui
    end

    subgraph "Domain/Model Layer"
      Company["Company"]:::domain
      Student["Student"]:::domain
      LoginRequest["LoginRequest"]:::domain
      LoginResponse["LoginResponse"]:::domain
      NotificationRequest["NotificationRequest"]:::domain
    end

    subgraph "Network/API Layer"
      AadhanApi["AadhanApi"]:::api
      NotificationApi["NotificationApi"]:::api
      AadhanApplication["AadhanApplication\n(HTTP client init)"]:::api
    end

    MyFirebaseMessagingService["MyFirebaseMessagingService"]:::api
  end

  subgraph "External Services"
    BackendREST[("Backend REST Service")]:::external
    BackendDB[("Backend Database")]:::external
    FCM[("Firebase Cloud Messaging")]:::external
  end

  %% Data Flows
  LoginActivity -->|"HTTPS JSON"| AadhanApi
  MainActivity -->|"HTTPS JSON"| AadhanApi
  AddCompanyActivity -->|"HTTPS JSON"| AadhanApi
  AddStudentActivity -->|"HTTPS JSON"| AadhanApi
  AdminActivity -->|"HTTPS JSON"| AadhanApi
  CompanyDetailActivity -->|"HTTPS JSON"| AadhanApi
  EditCompanyActivity -->|"HTTPS JSON"| AadhanApi
  EditStudentActivity -->|"HTTPS JSON"| AadhanApi
  InfoActivity -->|"HTTPS JSON"| AadhanApi
  SendNotificationActivity -->|"HTTPS JSON"| NotificationApi
  SplashActivity -->|"HTTPS JSON"| AadhanApi

  AadhanApi -->|"HTTPS JSON"| BackendREST
  NotificationApi -->|"HTTPS JSON"| BackendREST

  BackendREST -->|"JSON"| AadhanApi

  BackendREST -->|"Push via FCM"| FCM
  FCM -->|"FCM Message"| MyFirebaseMessagingService
  MyFirebaseMessagingService -->|"Update UI"| NotificationFragment

  %% Click Events
  click LoginActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/LoginActivity.java"
  click MainActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/MainActivity.java"
  click AddCompanyActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/AddCompanyActivity.java"
  click AddStudentActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/AddStudentActivity.java"
  click AdminActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/AdminActivity.java"
  click CompanyDetailActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/CompanyDetailActivity.java"
  click EditCompanyActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/EditCompanyActivity.java"
  click EditStudentActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/EditStudentActivity.java"
  click InfoActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/InfoActivity.java"
  click SendNotificationActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/SendNotificationActivity.java"
  click SplashActivity "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/SplashActivity.java"

  click HomeFragment "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/HomeFragment.java"
  click MapFragment "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/MapFragment.java"
  click NotificationFragment "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/NotificationFragment.java"
  click ProfileFragment "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/ProfileFragment.java"

  click CompanyAdapter "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/CompanyAdapter.java"
  click StudentAdapter "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/StudentAdapter.java"
  click EditCompanyAdapter "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/EditCompanyAdapter.java"
  click EditStudentAdapter "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/EditStudentAdapter.java"
  click CustomInfoWindowAdapter "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/CustomInfoWindowAdapter.java"
  click BitmapHelper "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/BitmapHelper.java"

  click Company "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/model/Company.java"
  click Student "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/model/Student.java"
  click LoginRequest "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/model/LoginRequest.java"
  click LoginResponse "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/model/LoginResponse.java"
  click NotificationRequest "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/model/NotificationRequest.java"

  click AadhanApi "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/api/AadhanApi.java"
  click NotificationApi "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/api/NotificationApi.java"
  click AadhanApplication "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/AadhanApplication.java"

  click MyFirebaseMessagingService "https://github.com/thisaakash/aadhantermwork/blob/main/app/src/main/java/com/aakash/aadhan/MyFirebaseMessagingService.java"

  classDef ui fill:#E0F7FA,stroke:#006064
  classDef domain fill:#E8F5E9,stroke:#1B5E20
  classDef api fill:#FFF3E0,stroke:#E65100
  classDef external fill:#ECEFF1,stroke:#607D8Bendmodule
```
