# simplyaditya/gembiz architecture

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

- Interactive diagram: https://gitdiagram.com/simplyaditya/gembiz
- Repository: https://github.com/simplyaditya/gembiz

## Overview

##### Project type and purpose
- This is a cross-platform Flutter application (“gem2”) targeting mobile (Android, iOS), desktop (Linux, macOS, Windows) and web.
- The app uses Firebase (Authentication, Firestore) plus a location/map service (OpenStreetMap), and presents business/store catalog, item management, ordering and user authentication flows.

##### File structure
- Top-level “android”, “ios”, “linux”, “macos”, “windows”, “web” directories are Flutter platform embeddings and build configurations.
- The “lib” directory contains the Dart code split into:
- auth (screens & logic for phone, OTP, update)
- models (data classes, e.g. ItemModel)
- providers (state management: AuthProvider, LocationProvider, StoreDataProvider, etc.)
- screens (UI pages: login, registration, catalogue, item details, order, etc.)
- utils (services like Firestore access, URL validation, OSM integration)
- widgets (reusable UI components: AppBar, SnackBar, BottomNavBar)
- Config files: firebase.json, android/google-services.json, ios/GoogleService-Info.plist, lib/firebase_options.dart
- pubspec.yaml / lock define dependencies (Flutter, Firebase packages, state management).

##### README
- Minimal; indicates a standard Flutter starter project.

##### Detail without over-splitting
- Layer and its core components.
- Avoid unnecessary micro-services—group related utils or providers.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Platform Embedders
    subgraph "Platform Targets" 
        direction TB
        Android["Android"]:::platform
        IOS["iOS"]:::platform
        Linux["Linux"]:::platform
        macOS["macOS"]:::platform
        Windows["Windows"]:::platform
        Web["Web"]:::platform
    end

    %% Flutter Engine & Entry Point
    FlutterEngine["Flutter Engine & Dart VM"]:::platform
    Main["main.dart"]:::platform

    Android -->|initializes| FlutterEngine
    IOS -->|initializes| FlutterEngine
    Linux -->|initializes| FlutterEngine
    macOS -->|initializes| FlutterEngine
    Windows -->|initializes| FlutterEngine
    Web -->|initializes| FlutterEngine
    FlutterEngine -->|executes| Main

    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        subgraph "Screens" 
            direction TB
            Login["login_screen.dart"]:::ui
            Registration["registration.dart"]:::ui
            VerificationOTP["verification_otp_screen.dart"]:::ui
            Catalogue["catalogue_screen.dart"]:::ui
            ItemDetails["item_details_screen.dart"]:::ui
            Order["order_screen.dart"]:::ui
            OSMView["openstreetmap_screen.dart"]:::ui
        end
        subgraph "Widgets"
            direction TB
            AppBar["custom_app_bar.dart"]:::ui
            BottomNav["bottom_nav_bar.dart"]:::ui
            SnackBar["snackbar.dart"]:::ui
            FullscreenImage["fullscreen_image.dart"]:::ui
        end
    end

    %% State Management Layer
    subgraph "State Management (Providers)"
        direction TB
        AuthProv["auth_provider.dart"]:::state
        OTPProv["otp_provider.dart"]:::state
        MobileProv["mobile_no_provider.dart"]:::state
        LocationProv["location_provider.dart"]:::state
        StoreDataProv["store_data_provider.dart"]:::state
        StoreVerifProv["store_verification_provider.dart"]:::state
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        subgraph "Models"
            ItemModel["item_model.dart"]:::data
        end
        subgraph "Services/Utils"
            FSUtil["firestore.dart"]:::data
            StoreService["store_service.dart"]:::data
            URLValidator["url_validator.dart"]:::data
            FirebaseOpts["firebase_options.dart"]:::data
        end
        subgraph "External Services"
            AuthService["Firebase Auth"]:::data
            FirestoreDB["Firestore Database"]:::data
            OSMService["OpenStreetMap API"]:::data
        end
    end

    %% Assets & Config
    subgraph "Assets & Config"
        direction TB
        Fonts["assets/fonts/"]:::platform
        Images["assets/images/"]:::platform
        IOSAssets["ios/Runner/Assets.xcassets/"]:::platform
        macOSAssets["macos/Runner/Assets.xcassets/"]:::platform
        FirebaseJson["firebase.json"]:::platform
        GoogleAndroid["android/app/google-services.json"]:::platform
        GoogleIOS["ios/Runner/GoogleService-Info.plist"]:::platform
        Pubspec["pubspec.yaml"]:::platform
    end

    %% Flow Arrows
    User["User"]:::platform
    User -->|"taps"| Login
    User -->|"taps"| Registration
    User -->|"taps"| Catalogue
    Login -->|"calls"| AuthProv
    Registration -->|"calls"| AuthProv
    VerificationOTP -->|"calls"| OTPProv
    Catalogue -->|"calls"| StoreDataProv
    ItemDetails -->|"calls"| StoreDataProv
    Order -->|"calls"| StoreDataProv
    OSMView -->|"calls"| LocationProv

    AppBar -->|"used in"| Login
    BottomNav -->|"used in"| Catalogue
    SnackBar -->|"used in"| Order
    FullscreenImage -->|"used in"| ItemDetails

    AuthProv -->|"uses"| FSUtil
    OTPProv -->|"uses"| FSUtil
    MobileProv -->|"uses"| FSUtil
    LocationProv -->|"uses"| FSUtil
    StoreDataProv -->|"uses"| StoreService
    StoreVerifProv -->|"uses"| StoreService

    FSUtil -->|"auth"| AuthService
    FSUtil -->|"db"| FirestoreDB
    StoreService -->|"db"| FirestoreDB
    URLValidator -->|"validates"| StoreService
    FirebaseOpts -->|"configures"| FlutterEngine

    AuthService -->|"token"| AuthProv
    FirestoreDB -->|"data"| StoreDataProv
    OSMService -->|"location"| LocationProv

    %% Click Events
    click Android "https://github.com/simplyaditya/gembiz/tree/app/android/"
    click IOS "https://github.com/simplyaditya/gembiz/tree/app/ios/"
    click Linux "https://github.com/simplyaditya/gembiz/tree/app/linux/"
    click macOS "https://github.com/simplyaditya/gembiz/tree/app/macos/"
    click Windows "https://github.com/simplyaditya/gembiz/tree/app/windows/"
    click Web "https://github.com/simplyaditya/gembiz/tree/app/web/"
    click Main "https://github.com/simplyaditya/gembiz/blob/app/lib/main.dart"
    click Login "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/login_screen.dart"
    click Registration "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/registration.dart"
    click VerificationOTP "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/verification_otp_screen.dart"
    click Catalogue "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/catalogue_screen.dart"
    click ItemDetails "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/item_details_screen.dart"
    click Order "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/order_screen.dart"
    click OSMView "https://github.com/simplyaditya/gembiz/blob/app/lib/screens/openstreetmap_screen.dart"
    click AppBar "https://github.com/simplyaditya/gembiz/blob/app/lib/widgets/custom_app_bar.dart"
    click BottomNav "https://github.com/simplyaditya/gembiz/blob/app/lib/widgets/bottom_nav_bar.dart"
    click SnackBar "https://github.com/simplyaditya/gembiz/blob/app/lib/widgets/snackbar.dart"
    click FullscreenImage "https://github.com/simplyaditya/gembiz/blob/app/lib/widgets/fullscreen_image.dart"
    click AuthProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/auth_provider.dart"
    click OTPProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/otp_provider.dart"
    click MobileProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/mobile_no_provider.dart"
    click LocationProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/location_provider.dart"
    click StoreDataProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/store_data_provider.dart"
    click StoreVerifProv "https://github.com/simplyaditya/gembiz/blob/app/lib/providers/store_verification_provider.dart"
    click ItemModel "https://github.com/simplyaditya/gembiz/blob/app/lib/models/item_model.dart"
    click FSUtil "https://github.com/simplyaditya/gembiz/blob/app/lib/utils/firestore.dart"
    click StoreService "https://github.com/simplyaditya/gembiz/blob/app/lib/utils/store_service.dart"
    click URLValidator "https://github.com/simplyaditya/gembiz/blob/app/lib/utils/url_validator.dart"
    click FirebaseOpts "https://github.com/simplyaditya/gembiz/blob/app/lib/utils/firebase_options.dart"
    click FirebaseJson "https://github.com/simplyaditya/gembiz/blob/app/firebase.json"
    click GoogleAndroid "https://github.com/simplyaditya/gembiz/blob/app/android/app/google-services.json"
    click GoogleIOS "https://github.com/simplyaditya/gembiz/blob/app/ios/Runner/GoogleService-Info.plist"
    click Pubspec "https://github.com/simplyaditya/gembiz/blob/app/pubspec.yaml"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366d6,color:#0366d6
    classDef state fill:#D2F8D2,stroke:#28a745,color:#28a745
    classDef data fill:#FFD8A8,stroke:#d9822b,color:#d9822b
    classDef platform fill:#E0E0E0,stroke:#6a737d,color:#6a737d
```
