# samarthtiku/coral architecture

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

- Interactive diagram: https://gitdiagram.com/samarthtiku/coral
- Repository: https://github.com/samarthtiku/coral

## Overview

##### Main Components

a. Client-Side (Android App):
- Present this as the top-level component
- Divide into clear architectural layers:
- UI Layer (Activities and Layouts)
- Business Logic Layer (Utils and Services)
- Data Layer (Models)
- Adapters Layer (For RecyclerViews)

b. Backend Services:
- Firebase Authentication
- Firebase Realtime Database
- Firebase Cloud Messaging (evident from CoralFirebaseMessagingService)

**[User Interface Layer]**
- SignIn/SignUp Activities
- Dashboard Activity
- Profile Activity
- Recommendations Activity
- Activity Log Management

**[Business Logic Layer]**
- CarbonCalculator
- RecommendationEngine
- ValidationUtils
- Firebase Utils

**[Data Layer]**
- User Model
- ActivityLog Model
- Recommendation Model

**[External Services]**
- Firebase Auth
- Firebase Realtime Database
- Firebase Cloud Messaging

##### Key Relationships to Highlight

a. Authentication Flow:
- SignInActivity/SignUpActivity → FirebaseUtils → Firebase Auth
- User data flow to Firebase Realtime Database

b. Core Application Flow:
- DashboardActivity → ActivityAdapter → ActivityLog Model
- AddActivityLogActivity → CarbonCalculator → Firebase Realtime Database

c. Recommendation System:
- RecommendationEngine → ActivityLog Data → User Recommendations

##### Additional Elements

- Version information
- Third-party dependencies
- Error handling paths
- Asynchronous operations

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef ui fill:#90EE90,stroke:#333,stroke-width:2px
    classDef business fill:#ADD8E6,stroke:#333,stroke-width:2px
    classDef data fill:#FFE4B5,stroke:#333,stroke-width:2px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef adapter fill:#FFA07A,stroke:#333,stroke-width:2px
    classDef service fill:#20B2AA,stroke:#333,stroke-width:2px

    %% UI Layer
    subgraph UILayer["UI Layer"]
        SignIn["Sign In Activity"]:::ui
        SignUp["Sign Up Activity"]:::ui
        Dashboard["Dashboard Activity"]:::ui
        Profile["Profile Activity"]:::ui
        Recommendations["Recommendations Activity"]:::ui
        ActivityLog["Add Activity Log"]:::ui
    end

    %% Business Logic Layer
    subgraph BusinessLayer["Business Logic Layer"]
        Calculator["Carbon Calculator"]:::business
        RecEngine["Recommendation Engine"]:::business
        Validation["Validation Utils"]:::business
        FBUtils["Firebase Utils"]:::business
    end

    %% Data Layer
    subgraph DataLayer["Data Layer"]
        UserModel["User Model"]:::data
        LogModel["Activity Log Model"]:::data
        RecModel["Recommendation Model"]:::data
    end

    %% Adapters Layer
    subgraph AdapterLayer["Adapters Layer"]
        ActivityAdapter["Activity Adapter"]:::adapter
    end

    %% External Services
    subgraph ExternalServices["External Services"]
        Auth["Firebase Auth"]:::external
        Database["Firebase Realtime DB"]:::external
        FCM["Firebase Cloud Messaging"]:::external
    end

    %% Service Layer
    FCMService["Coral Firebase Messaging Service"]:::service

    %% Relationships
    SignIn & SignUp --> FBUtils
    FBUtils --> Auth
    FBUtils --> Database
    
    Dashboard --> ActivityAdapter
    ActivityAdapter --> LogModel
    
    ActivityLog --> Calculator
    Calculator --> LogModel
    LogModel --> Database
    
    RecEngine --> LogModel
    RecEngine --> RecModel
    Recommendations --> RecModel
    
    FCM --> FCMService
    FCMService --> Dashboard

    %% Click Events
    click SignIn "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/SignInActivity.kt"
    click SignUp "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/SignUpActivity.kt"
    click Dashboard "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/DashboardActivity.kt"
    click Profile "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/ProfileActivity.kt"
    click Recommendations "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/RecommendationsActivity.kt"
    click ActivityLog "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/activities/AddActivityLogActivity.kt"
    click Calculator "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/utils/CarbonCalculator.kt"
    click RecEngine "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/utils/RecommendationEngine.kt"
    click Validation "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/utils/ValidationUtils.kt"
    click FBUtils "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/utils/FirebaseUtils.kt"
    click UserModel "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/models/User.kt"
    click LogModel "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/models/ActivityLog.kt"
    click RecModel "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/models/Recommendation.kt"
    click ActivityAdapter "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/adapters/ActivityAdapter.kt"
    click FCMService "https://github.com/samarthtiku/CORAL/blob/main/app/src/main/java/com/coral/services/CoralFirebaseMessagingService.kt"
```
