# ikraorhan/cs-310-term-project architecture

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

- Interactive diagram: https://gitdiagram.com/ikraorhan/cs-310-term-project
- Repository: https://github.com/ikraorhan/cs-310-term-project

## Overview

##### Project type and purpose
- This is a cross-platform Flutter application (Android, iOS, Web, Windows, macOS, Linux) named “tick_task.”
- It’s a task management app with features like signup/login, daily/weekly reviews, task creation and management, and push/local notifications.
- Firebase is used as the backend (Authentication, Firestore, Storage, Cloud Functions/Rules).

##### File structure
Top-level directories
- android, ios, linux, macos, windows, web – platform-specific host projects and build wrappers created by Flutter.
- lib – the Dart application code shared across all platforms.
- firebase.json, firestore.rules, firestore.indexes.json, firebase.storage.rules – Firebase configuration and security rules.
- pubspec.yaml – declares Flutter SDK, dependencies (firebase_core, cloud_firestore, firebase_auth, etc.), assets, fonts.

Inside lib/
- firebase_options.dart – auto-generated Firebase configuration for each platform
- models/ – data models (Task, User)
- providers/ – state-management classes (TaskProvider, UserProvider)
- services/ – cross-cutting services (NotificationService)
- routes/ – UI screens and navigation (login, signup, home, manageTask, dailyReview, weeklyReview, settings, howTo, welcome)
- main.dart – Flutter app entrypoint, sets up Firebase, injects providers, defines initial route.

##### README
- No architectural details are provided there beyond team membership. All architectural insight will come from code structure and config files.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Platform Hosts
    subgraph "Platform Host Containers"
        Android["Android Shell"]:::host
        iOS["iOS Shell"]:::host
        Web["Web Shell"]:::host
        Linux["Linux Shell"]:::host
        macOS["macOS Shell"]:::host
        Windows["Windows Shell"]:::host
    end

    %% Flutter Application
    subgraph "Flutter Application (lib/)"
        Entry["main.dart"]:::entry
        subgraph "UI Layer (routes/)" 
            AddTask["addNewTask.dart"]:::ui
            DailyReview["dailyReview.dart"]:::ui
            Home["home.dart"]:::ui
            HowTo["howTo.dart"]:::ui
            Login["login.dart"]:::ui
            ManageTask["manageTask.dart"]:::ui
            Review["review.dart"]:::ui
            Settings["settings.dart"]:::ui
            Signup["signup.dart"]:::ui
            WeeklyReview["weeklyReview.dart"]:::ui
            Welcome["welcome.dart"]:::ui
        end
        subgraph "State Layer (providers/)"
            TaskProvider["task_provider.dart"]:::state
            UserProvider["user_provider.dart"]:::state
        end
        subgraph "Data Models (models/)"
            TaskModel["task.dart"]:::model
            UserModel["user_model.dart"]:::model
        end
        subgraph "Service Layer (services/)"
            NotificationService["notification_service.dart"]:::service
        end
        Config["firebase_options.dart"]:::config
        subgraph "Assets (assets/)"
            Assets["Static Assets"]:::asset
        end
        subgraph "Utilities (util/)"
            Colors["colors.dart"]:::util
            Styles["styles.dart"]:::util
        end
    end

    %% Firebase Backend
    subgraph "Firebase Backend (Cloud)"
        Auth["Authentication"]:::cloud
        Firestore["Cloud Firestore"]:::db
        Storage["Firebase Storage"]:::cloud
    end

    %% Firebase Rules & Config
    subgraph "Firebase Config & Rules"
        FirebaseJSON["firebase.json"]:::config
        FirestoreRules["firestore.rules"]:::config
        FirestoreIndexes["firestore.indexes.json"]:::config
        StorageRules["firebase.storage.rules"]:::config
    end

    %% Connections
    Entry -->|"launches"| Home
    AddTask -->|"dispatches event"| TaskProvider
    DailyReview -->|"dispatches event"| TaskProvider
    Home -->|"dispatches event"| UserProvider
    Login -->|"dispatches event"| UserProvider
    Signup -->|"dispatches event"| UserProvider
    ManageTask -->|"dispatches event"| TaskProvider
    Review -->|"dispatches event"| TaskProvider
    WeeklyReview -->|"dispatches event"| TaskProvider
    Welcome -->|"dispatches event"| UserProvider
    Settings -->|"dispatches event"| UserProvider
    HowTo -->|"dispatches event"| UserProvider

    TaskProvider -->|"calls"| NotificationService
    UserProvider -->|"calls"| NotificationService

    NotificationService -->|"uses SDK"| Auth
    NotificationService -->|"uses SDK"| Firestore
    NotificationService -->|"uses SDK"| Storage

    Auth -->|"response"| NotificationService
    Firestore -->|"response"| NotificationService
    Storage -->|"response"| NotificationService

    NotificationService -->|"updates"| TaskProvider
    NotificationService -->|"updates"| UserProvider

    %% Platforms embedding
    Android --> Entry
    iOS --> Entry
    Web --> Entry
    Linux --> Entry
    macOS --> Entry
    Windows --> Entry

    %% Click Events
    click Entry "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/main.dart"
    click AddTask "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/addNewTask.dart"
    click DailyReview "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/dailyReview.dart"
    click Home "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/home.dart"
    click HowTo "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/howTo.dart"
    click Login "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/login.dart"
    click ManageTask "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/manageTask.dart"
    click Review "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/review.dart"
    click Settings "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/settings.dart"
    click Signup "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/signup.dart"
    click WeeklyReview "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/weeklyReview.dart"
    click Welcome "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/routes/welcome.dart"
    click TaskProvider "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/providers/task_provider.dart"
    click UserProvider "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/providers/user_provider.dart"
    click TaskModel "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/models/task.dart"
    click UserModel "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/models/user_model.dart"
    click NotificationService "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/services/notification_service.dart"
    click Config "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/firebase_options.dart"
    click FirebaseJSON "https://github.com/ikraorhan/cs-310-term-project/blob/main/firebase.json"
    click FirestoreRules "https://github.com/ikraorhan/cs-310-term-project/blob/main/firestore.rules"
    click FirestoreIndexes "https://github.com/ikraorhan/cs-310-term-project/blob/main/firestore.indexes.json"
    click StorageRules "https://github.com/ikraorhan/cs-310-term-project/blob/main/firebase.storage.rules"
    click Assets "https://github.com/ikraorhan/cs-310-term-project/tree/main/lib/assets/"
    click Colors "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/util/colors.dart"
    click Styles "https://github.com/ikraorhan/cs-310-term-project/blob/main/lib/util/styles.dart"

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#000
    classDef state fill:#90EE90,stroke:#000
    classDef service fill:#FFFF99,stroke:#000
    classDef cloud fill:#FFA500,stroke:#000
    classDef db fill:#FFD700,stroke:#000
    classDef host fill:#D3D3D3,stroke:#000
    classDef entry fill:#ADD8E6,stroke:#000
    classDef model fill:#E6E6FA,stroke:#000
    classDef config fill:#E6E6FA,stroke:#000
    classDef asset fill:#FFDAB9,stroke:#000
    classDef util fill:#E0FFFF,stroke:#000
```
