# kimmidhingra/rssbnominalrole architecture

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

- Interactive diagram: https://gitdiagram.com/kimmidhingra/rssbnominalrole
- Repository: https://github.com/kimmidhingra/rssbnominalrole

## Overview

##### Project Type and Purpose
- This is a cross-platform Flutter mobile (and desktop/web) application named RSSBNominalRole.
- Purpose: allow RSSB center administrators to build and manage nominal rolls of sewadars—import/export Excel lists, store locally, pick date ranges, and display/modify records.

##### File Structure Analysis
- Top-level “android”, “ios”, “linux”, “macos”, “windows”, “web” directories: Flutter platform integration code and native runners.
- “lib/” is the core Dart code:
- lib/main.dart – app entry point
- lib/Screens/ – UI pages (MasterList, AddSewadar, CreateNominalRole, etc.)
- lib/common_widgets/ – reusable widgets (pop-scope wrappers, role builders)
- lib/model/ – domain models (NominalRole, Sewadar)
- lib/service/ – business/data services (DatabaseService, ExcelServices, FileService)
- lib/utils/ – helper classes (DateFormatter, phone utilities)
- Configuration & build scripts: pubspec.yaml/lock, analysis_options.yaml, platform gradle/CMake files.

##### README Insights
- Core features: SQFLite local DB (with FK constraints), date-range selection via Syncfusion DatePicker, Excel import/export via ‘excel’ & ‘syncfusion_flutter_xlsio’.

##### Main Components
a. Presentation Layer (UI)
- Screens & Widgets (lib/Screens, lib/common_widgets)
- Syncfusion DatePicker component
b. Business Logic / Service Layer
- DatabaseService (wraps SQFLite)
- ExcelServices (reads .xlsx)
- FileService (reads/writes to local storage)
c. Data Layer
- Local SQLite database (SQFLite plugin)
- File system access (read/write Excel files)
d. External Libraries & Framework
- Flutter Framework & Dart runtime
- syncfusion_flutter_xlsio, excel, intl, sqflite plugins
e. Platform Runners
- Android (Gradle, native C++)
- iOS (Xcode project, Swift/Obj-C)
- Linux/MacOS/Windows (CMake runners)
- Web (index.html + JS)

##### Relationships & Data Flows
- UI → invokes Service Layer methods (e.g., addSewadar, exportExcel)
- DatabaseService ↔ SQLite engine (CRUD operations)
- ExcelServices → excel APIs → parse master_list.xlsx (assets)
- FileService → file system storage (write generated .xlsx files)
- Flow of control: User taps UI → service → data layer → returns results → UI updates.

##### Architectural Patterns & Principles
- Layered architecture (Presentation → Business/Services → Data)
- Separation of concerns: UI vs. models vs. services vs. utils
- Plugin-based integration for cross-platform features
- Use of Futures/async for data operations (implied in services)

## Diagram (Mermaid)

```mermaid
graph TD
    %% Flutter Framework
    FlutterFW["Flutter Framework & Dart Runtime"]:::external

    %% Flutter App Container
    subgraph "Flutter App"
        direction TB

        MainApp["main.dart"]:::frontend
        click MainApp "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/main.dart"

        subgraph "Presentation Layer"
            direction TB
            MLScreen["MasterListScreen"]:::frontend
            click MLScreen "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/Screens/MasterListScreen.dart"
            AddScreen["AddSewadarScreen"]:::frontend
            click AddScreen "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/Screens/AddSewadarScreen.dart"
            CreateScreen["CreateNominalRoleScreen"]:::frontend
            click CreateScreen "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/Screens/CreateNominalRoleScreen.dart"
            DocScreen["NominalRoleDocScreen"]:::frontend
            click DocScreen "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/Screens/NominalRoleDocScreen.dart"
            NRoleBuilder["Nominal Role Builder"]:::frontend
            click NRoleBuilder "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/common_widgets/nomination_role_builder.dart"
            PopWrapper["Pop-Scope Wrapper"]:::frontend
            click PopWrapper "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/common_widgets/pop_scope_wrapper.dart"
            DatePicker["Syncfusion DatePicker"]:::frontend
            click DatePicker "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/DatePicker.dart"
        end

        subgraph "Service Layer"
            direction TB
            DBSvc["DatabaseService"]:::services
            click DBSvc "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/service/DatabaseService.dart"
            ExcelSvc["ExcelServices"]:::services
            click ExcelSvc "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/service/ExcelServices.dart"
            FileSvc["FileService"]:::services
            click FileSvc "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/service/FileService.dart"
        end

        subgraph "Data Layer"
            direction TB
            subgraph "Domain Models"
                NRoleMod["NominalRole"]:::data
                click NRoleMod "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/model/NominalRole.dart"
                SewMod["Sewadar"]:::data
                click SewMod "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/model/Sewadar.dart"
            end
            SQLiteDB["SQLite Database"]:::data
            FileSys["File System Storage"]:::data
        end

        subgraph "Utils"
            direction TB
            DateFmt["DateFormatter"]:::utils
            click DateFmt "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/utils/DateFormatter.dart"
            PhoneUtil["Phone Utilities"]:::utils
            click PhoneUtil "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/utils/phone_utils.dart"
            GenUtils["General Utils"]:::utils
            click GenUtils "https://github.com/kimmidhingra/rssbnominalrole/blob/main/lib/utils/utils.dart"
        end
    end

    %% External Libraries & Plugins
    subgraph "External Libraries & Plugins"
        direction TB
        SyncXLSIO["syncfusion_flutter_xlsio"]:::external
        ExcelLib["excel"]:::external
        Intl["intl"]:::external
        SQFLiteLib["sqflite"]:::external
    end

    %% Assets
    subgraph "Assets"
        direction TB
        Template["master_list.xlsx"]:::external
        click Template "https://github.com/kimmidhingra/rssbnominalrole/blob/main/assets/excel/master_list.xlsx"
        Icons["Icons"]:::external
        click Icons "https://github.com/kimmidhingra/rssbnominalrole/tree/main/assets/icons/"
    end

    %% Platform Runners
    subgraph "Platform Runners"
        direction TB
        Android["Android (MainActivity.kt)"]:::platform
        click Android "https://github.com/kimmidhingra/rssbnominalrole/blob/main/android/app/src/main/kotlin/com/example/nominal_role/MainActivity.kt"
        iOS["iOS (AppDelegate.swift)"]:::platform
        click iOS "https://github.com/kimmidhingra/rssbnominalrole/blob/main/ios/Runner/AppDelegate.swift"
        Linux["Linux (main.cc)"]:::platform
        click Linux "https://github.com/kimmidhingra/rssbnominalrole/blob/main/linux/main.cc"
        MacOS["macOS (AppDelegate.swift)"]:::platform
        click MacOS "https://github.com/kimmidhingra/rssbnominalrole/blob/main/macos/Runner/AppDelegate.swift"
        Win["Windows (main.cpp)"]:::platform
        click Win "https://github.com/kimmidhingra/rssbnominalrole/blob/main/windows/runner/main.cpp"
        Web["Web (index.html)"]:::platform
        click Web "https://github.com/kimmidhingra/rssbnominalrole/blob/main/web/index.html"
    end

    %% Connections
    FlutterFW -->|"runs"| MainApp

    MainApp -->|launches| MLScreen
    MainApp -->|launches| AddScreen
    MainApp -->|launches| CreateScreen
    MainApp -->|launches| DocScreen

    MLScreen -->|"CRUD"| DBSvc
    AddScreen -->|"addSewadar"| DBSvc
    CreateScreen -->|"createNominalRole"| ExcelSvc
    DocScreen -->|"exportDoc"| ExcelSvc

    DBSvc -->|reads/writes| SQLiteDB
    DBSvc -->|via plugin| SQFLiteLib

    ExcelSvc -->|parses template| Template
    ExcelSvc -->|uses| ExcelLib
    ExcelSvc -->|generates| FileSvc
    ExcelSvc -->|uses| SyncXLSIO

    FileSvc -->|writes/reads| FileSys

    DatePicker -->|formats dates| Intl
    DatePicker -->|embedded in UI| CreateScreen

    %% External library links
    DBSvc -.async.-> SQFLiteLib
    DateFmt -.util.-> GenUtils

    %% Platform
    FlutterFW --> Android
    FlutterFW --> iOS
    FlutterFW --> Linux
    FlutterFW --> MacOS
    FlutterFW --> Win
    FlutterFW --> Web

    %% Styles
    classDef frontend fill:#ccf,stroke:#333,stroke-width:1px
    classDef services fill:#cfc,stroke:#333,stroke-width:1px
    classDef data fill:#fc9,stroke:#333,stroke-width:1px
    classDef utils fill:#ffc,stroke:#333,stroke-width:1px
    classDef external fill:#ddd,stroke:#333,stroke-width:1px
    classDef platform fill:#dcd,stroke:#333,stroke-width:1px
```
