# deepak-kumar-01/student-app architecture

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

- Interactive diagram: https://gitdiagram.com/deepak-kumar-01/student-app
- Repository: https://github.com/deepak-kumar-01/student-app

## Overview

##### Project type and purpose
- This is a cross-platform (iOS/Android/Linux/macOS) mobile application built in Flutter.
- Purpose: A “University Student App” providing onboarding, authentication, timetable, attendance, study materials, faculty/club info, backups, and admin/user role management.
- Backend integration is via Firebase (Authentication, Firestore/Realtime DB, Cloud Storage) plus an external timetable API.

##### File structure
Top‐level directories
- android / ios / linux / macos – platform wrappers generated by Flutter
- lib – all Dart source code
- assets – fonts, images, splash config
- test – widget and admin UI tests
- firebase.json & lib/firebase_options.dart – Firebase config
Key lib subdirectories
- screens/… – presentation layer, feature-based (onboarding, login/signup, home, routine, attendance, profile, admin, responsive UIs)
- providers/… – state management using ChangeNotifier/Provider (e.g. authProvider.dart)
- services/… – data/business logic (authentication.dart, databaseServices.dart, backup.dart, excelHandler.dart, secureStorage.dart)
- modals/… – domain models (authStudent, timetableModal, users, etc.)
- wrapper.dart – routes user into onboarding→login/home based on auth state
- main.dart – app entrypoint, MultiProvider setup

##### README for additional insights
- Confirms Firebase authentication (admin vs user roles), mobile screenshots (light/dark mode), old codebase indicator
- Live demo URL on Appetize.io

##### Diagramming recommendations
- Blue for client-side components (UI & state)
- Green for service/data layer
- Orange for external systems (Firebase, REST API)

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "Mobile App"
    direction TB

    entry["App Entry Point\n(main.dart)"]:::client
    wrapper["Routing Wrapper\n(wrapper.dart)"]:::client

    subgraph "UI Layer"
      direction TB
      onboarding["Onboarding"]:::client
      login["Login / Signup"]:::client
      forgotPwd["Forgot / Change Password"]:::client
      home["Home / Dashboard"]:::client
      timetableUI["Timetable"]:::client
      attendance["Attendance"]:::client
      study["Study Materials"]:::client
      faculty["Faculty & Clubs"]:::client
      clubList["Clubs List"]:::client
      adminUI["Admin Module"]:::client
    end

    subgraph "State Layer"
      direction TB
      authProv["AuthProvider"]:::client
      timetableCtrl["TimetablePageController"]:::client
    end

    subgraph "Service Layer"
      direction TB
      authSvc["AuthenticationService"]:::service
      dbSvc["DatabaseService"]:::service
      backupSvc["BackupService"]:::service
      excel["ExcelHandler"]:::service
      secureSvc["SecureStorage"]:::service
    end

    subgraph "Domain Models"
      direction TB
      models["AuthStudent,\n TimetableModal,\n Users, etc."]:::service
    end

    entry --> wrapper
    wrapper --> onboarding
    wrapper --> login
    wrapper --> forgotPwd
    wrapper --> home

    login --> authProv
    forgotPwd --> authProv
    authProv --> authSvc
    authSvc --> firebaseAuth

    home --> dbSvc
    attendance --> dbSvc
    study --> dbSvc
    faculty --> dbSvc
    clubList --> dbSvc
    adminUI --> dbSvc
    dbSvc --> firestore
    dbSvc --> models

    timetableUI --> timetableCtrl
    timetableCtrl --> dbSvc
    timetableCtrl --> timetableAPI
    timetableCtrl --> secureSvc

    backupSvc --> dbSvc
    backupSvc --> excel
    backupSvc --> storage
    excel --> secureSvc

  end

  subgraph "External Services"
    direction TB
    firebaseAuth[(Firebase Auth)]:::external
    firestore[(Firestore)]:::external
    storage[(Cloud Storage)]:::external
    timetableAPI[(University Timetable API)]:::external
  end

  click entry "https://github.com/deepak-kumar-01/student-app/blob/master/lib/main.dart"
  click wrapper "https://github.com/deepak-kumar-01/student-app/blob/master/lib/wrapper.dart"
  click authSvc "https://github.com/deepak-kumar-01/student-app/blob/master/lib/services/authentication.dart"
  click dbSvc "https://github.com/deepak-kumar-01/student-app/blob/master/lib/services/databaseServices.dart"
  click backupSvc "https://github.com/deepak-kumar-01/student-app/blob/master/lib/services/backup.dart"
  click excel "https://github.com/deepak-kumar-01/student-app/blob/master/lib/services/excelHandler.dart"
  click secureSvc "https://github.com/deepak-kumar-01/student-app/blob/master/lib/services/secureStorage.dart"
  click authProv "https://github.com/deepak-kumar-01/student-app/blob/master/lib/providers/authProvider.dart"
  click onboarding "https://github.com/deepak-kumar-01/student-app/tree/master/lib/screens/responsiveScreens/"
  click login "https://github.com/deepak-kumar-01/student-app/tree/master/lib/screens/responsiveScreens/login/"
  click forgotPwd "https://github.com/deepak-kumar-01/student-app/blob/master/lib/forgot password/forgotpassword.dart"
  click home "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/homepage.dart"
  click timetableUI "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/Routine/timetable.dart"
  click attendance "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/attendance/attendancelist.dart"
  click study "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/studyMaterials/notes.dart"
  click faculty "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/facultyClub/faculty/faculty.dart"
  click clubList "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/clubList/ClubList.dart"
  click adminUI "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/admin/admin.dart"
  click timetableAPI "https://github.com/deepak-kumar-01/student-app/blob/master/lib/screens/Routine/timetable_api.dart"

  classDef client fill:#ADD8E6,stroke:#000,stroke-width:1px
  classDef service fill:#90EE90,stroke:#000,stroke-width:1px
  classDef external fill:#FFA500,stroke:#000,stroke-width:1px
  class entry,wrapper,onboarding,login,forgotPwd,home,attendance,study,faculty,clubList,adminUI,authProv,timetableCtrl client
  class authSvc,dbSvc,backupSvc,excel,secureSvc,models service
  class firebaseAuth,firestore,storage,timetableAPI external
```
