# dnyaneshjk/geo_attendance architecture

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

- Interactive diagram: https://gitdiagram.com/dnyaneshjk/geo_attendance
- Repository: https://github.com/dnyaneshjk/geo_attendance

## Overview

##### Project type and purpose
- This is a cross-platform mobile & desktop Flutter application (“geo_attendence”) for tracking attendance via geolocation.
- Key indicators: presence of `lib/` with Dart UI pages (`login_page.dart`, `admin_dashboard.dart`, etc.), platform folders (`android/`, `ios/`, `windows/`, `linux/`, `macos/`, `web/`), and a `google-services.json` file (Firebase integration).

##### File structure
- Top-level directories:
- android/, ios/, macos/, linux/, windows/, web/ → platform-specific embedders & configs
- lib/ → Flutter UI & business logic in Dart
- test/ → Flutter widget tests
- Platform folders each contain an “embedder” layer (Java/Kotlin for Android, Swift/Objective-C for iOS/macOS, C++ for Linux/Windows, HTML/JS for Web) plus config files (Gradle, Xcode project, CMake).
- pubspec.yaml/pubspec.lock define dependencies (Flutter SDK, Firebase, geolocation plugins, etc.).
- No server code present—backend is an external service (Firebase).

##### README for additional insights
- Very high-level: “A starting point for a Flutter application.”
- No built-in backend code; must rely on remote services (e.g., Firebase Auth/Firestore) and native device features (GPS).

##### Main components
a. Client Application (Flutter)
- Presentation Layer (UI Screens: Login, Signup, Staff/Admin Dashboards)
- Business Logic Layer (Attendance workflows, form validation, state management)
- Data Access Layer (services for authentication, geolocation, data persistence)
b. Flutter Engine & Platform Channels
- Platform Embedders for Android, iOS, Web, Windows, macOS, Linux
- Plugin interfaces (Dart ←→ native code) for camera, GPS, local storage
c. External Services
- Firebase Authentication (user sign-in/up)
- Firebase Cloud Firestore (attendance records)
- (Optional) Firebase Analytics, Crashlytics, Cloud Functions
d. Local Device Resources
- GPS Sensor (geolocation plugin)
- Secure Storage (e.g., SharedPreferences / Keychain for tokens)

##### Relationships & data flows
- UI Screens → invoke Business Logic → call Data Access Services.
- Data Access Services → communicate via FlutterFire plugins → Firebase Auth / Firestore.
- Business Logic may request device GPS permission through Platform Channels → native GPS API → return coordinates.
- All cross-platform code runs on top of the Flutter Engine; the engine delegates to each platform embedder.

##### Architectural patterns & design principles
- Layered Architecture: UI → Logic → Data
- Plugin-based modularity (FlutterFire, geolocator)
- Single codebase for multi-platform delivery
- Clean separation: business logic in Dart; presentation and native integration abstracted via plugins.

##### Technologies & frameworks to call out
- Flutter SDK (Dart)
- Flutter Engine & platform embedders (Android: Kotlin, iOS/macOS: Swift/Obj-C, Desktop: C++, Web: HTML/JS)
- Firebase (Auth, Firestore) via flutterfire packages
- Geolocation plugin package (e.g., geolocator)
- Gradle (Android), Xcode (iOS/macOS), CMake (Windows/Linux), web toolchain

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Core Application Layers
    subgraph "Cross-Platform Flutter App"
        direction TB
        subgraph "UI Layer"
            direction TB
            Main["lib/main.dart"]:::flutterModule
            Login["lib/login_page.dart"]:::flutterModule
            Signup["lib/signup_page.dart"]:::flutterModule
            StaffDash["lib/staff_dashboard.dart"]:::flutterModule
            AdminDash["lib/admin_dashboard.dart"]:::flutterModule
        end
        subgraph "Business Logic Layer"
            direction TB
            AuthLogic["AuthenticationService"]:::flutterModule
            AttendanceLogic["AttendanceService"]:::flutterModule
        end
        subgraph "Data Access Layer"
            direction TB
            GeoPlugin["Geolocator Plugin"]:::flutterModule
            AuthService["AuthenticationService"]:::flutterModule
            FirestoreService["FirestoreService"]:::flutterModule
            StorageService["SecureStorageService"]:::flutterModule
        end
    end

    %% Flutter Engine Wrapper
    subgraph "Flutter Engine"
        direction TB
        CrossPlatformApp["Cross-Platform Flutter App"]:::flutterModule
    end

    %% Platform Embedders
    subgraph "Platform Embedders"
        direction TB
        subgraph "Android Embedder"
            direction TB
            AndroidMain["MainActivity.kt"]:::platform
            AndroidGradle["build.gradle.kts"]:::platform
            AndroidConfig["google-services.json"]:::platform
        end
        subgraph "iOS Embedder"
            direction TB
            iOSAppDelegate["AppDelegate.swift"]:::platform
            iOSInfo["Info.plist"]:::platform
            iOSProj["Runner.xcodeproj"]:::platform
        end
        subgraph "macOS Embedder"
            direction TB
            MacAppDelegate["AppDelegate.swift"]:::platform
            MacWindow["MainFlutterWindow.swift"]:::platform
            MacProj["Runner.xcodeproj"]:::platform
        end
        subgraph "Linux Embedder"
            direction TB
            LinuxMain["main.cc"]:::platform
            LinuxApp["my_application.cc/.h"]:::platform
            LinuxPluginReg["generated_plugin_registrant.cc"]:::platform
        end
        subgraph "Windows Embedder"
            direction TB
            WinMain["main.cpp"]:::platform
            WinWindow["flutter_window.cpp/.h"]:::platform
            WinPluginReg["generated_plugin_registrant.cc"]:::platform
        end
        subgraph "Web Embedder"
            direction TB
            WebIndex["index.html"]:::platform
            WebManifest["manifest.json"]:::platform
        end
    end

    %% External Services
    FirebaseAuth(("Firebase Auth")):::external
    Firestore(("Cloud Firestore")):::external

    %% Device Resources
    GPS((GPS Sensor)):::device
    SecureStore((Secure Storage)):::device

    %% Testing
    Test["test/widget_test.dart"]:::testing

    %% Connections
    Main -->|navigates to| Login
    Main -->|navigates to| Signup
    Login -->|submits credentials| AuthLogic
    Signup -->|submits details| AuthLogic
    StaffDash -->|requests data| AttendanceLogic
    AdminDash -->|requests data| AttendanceLogic

    AuthLogic -->|calls| AuthService
    AttendanceLogic -->|calls| FirestoreService
    AttendanceLogic -->|uses| GeoPlugin
    AttendanceLogic -->|uses| StorageService

    AuthService -->|via FlutterFire| FirebaseAuth
    FirestoreService -->|via FlutterFire| Firestore

    GeoPlugin -->|Platform Channel| GPS
    StorageService -->|Platform Channel| SecureStore

    CrossPlatformApp --> AndroidMain
    CrossPlatformApp --> iOSAppDelegate
    CrossPlatformApp --> MacAppDelegate
    CrossPlatformApp --> LinuxMain
    CrossPlatformApp --> WinMain
    CrossPlatformApp --> WebIndex

    Test --> Main
    Test --> AuthLogic

    %% Click Events
    click Main "https://github.com/dnyaneshjk/geo_attendance/blob/master/lib/main.dart"
    click Login "https://github.com/dnyaneshjk/geo_attendance/blob/master/lib/login_page.dart"
    click Signup "https://github.com/dnyaneshjk/geo_attendance/blob/master/lib/signup_page.dart"
    click StaffDash "https://github.com/dnyaneshjk/geo_attendance/blob/master/lib/staff_dashboard.dart"
    click AdminDash "https://github.com/dnyaneshjk/geo_attendance/blob/master/lib/admin_dashboard.dart"
    click AndroidMain "https://github.com/dnyaneshjk/geo_attendance/blob/master/android/app/src/main/kotlin/com/example/geo_attendence/MainActivity.kt"
    click AndroidGradle "https://github.com/dnyaneshjk/geo_attendance/blob/master/android/app/build.gradle.kts"
    click AndroidConfig "https://github.com/dnyaneshjk/geo_attendance/blob/master/android/app/google-services.json"
    click iOSAppDelegate "https://github.com/dnyaneshjk/geo_attendance/blob/master/ios/Runner/AppDelegate.swift"
    click iOSInfo "https://github.com/dnyaneshjk/geo_attendance/blob/master/ios/Runner/Info.plist"
    click iOSProj "https://github.com/dnyaneshjk/geo_attendance/blob/master/ios/Runner.xcodeproj"
    click MacAppDelegate "https://github.com/dnyaneshjk/geo_attendance/blob/master/macos/Runner/AppDelegate.swift"
    click MacWindow "https://github.com/dnyaneshjk/geo_attendance/blob/master/macos/Runner/MainFlutterWindow.swift"
    click MacProj "https://github.com/dnyaneshjk/geo_attendance/blob/master/macos/Runner.xcodeproj"
    click LinuxMain "https://github.com/dnyaneshjk/geo_attendance/blob/master/linux/runner/main.cc"
    click LinuxApp "https://github.com/dnyaneshjk/geo_attendance/blob/master/linux/runner/my_application.cc/.h"
    click LinuxPluginReg "https://github.com/dnyaneshjk/geo_attendance/blob/master/linux/flutter/generated_plugin_registrant.cc"
    click WinMain "https://github.com/dnyaneshjk/geo_attendance/blob/master/windows/runner/main.cpp"
    click WinWindow "https://github.com/dnyaneshjk/geo_attendance/blob/master/windows/runner/flutter_window.cpp/.h"
    click WinPluginReg "https://github.com/dnyaneshjk/geo_attendance/blob/master/windows/flutter/generated_plugin_registrant.cc"
    click WebIndex "https://github.com/dnyaneshjk/geo_attendance/blob/master/web/index.html"
    click WebManifest "https://github.com/dnyaneshjk/geo_attendance/blob/master/web/manifest.json"
    click Test "https://github.com/dnyaneshjk/geo_attendance/blob/master/test/widget_test.dart"

    %% Styling
    classDef flutterModule fill:#AED6F1,stroke:#21618C,color:#1B2631;
    classDef external fill:#D5DBDB,stroke:#1B2631,color:#1B2631,shape:cylinder;
    classDef platform fill:#A9DFBF,stroke:#196F3D,color:#1B2631;
    classDef device fill:#FCF3CF,stroke:#7D6608,color:#1B2631,shape:circle;
    classDef testing fill:#F5B7B1,stroke:#922B21,color:#1B2631;
```
