How narenmicom/student-navi works
Project type and purpose
• Project type: A cross-platform Flutter full-stack application (targets Android, iOS, Web, Windows, Linux).
• Purpose: Provide a “Student-Navi” interface for students and faculty to manage announcements, events, attendance, notes, etc., with authentication and data storage powered by Supabase.
File structure
• Top-level platform folders (android/, ios/, web/, linux/, windows/) indicate Flutter’s multi-platform support.
• The lib/ directory follows a layered architecture:
– lib/views/… → Presentation layer with Flutter widgets and BLoC classes per feature (Announcements, Events, Attendance, Subjects).
– lib/services/… → Service layer, including auth (AuthProvider, SupabaseProvider) and BLoC providers.
– lib/helpers/… & lib/utilities/… → UI helpers (loading screens, dialogs, size config, side drawer).
• State management: BLoC pattern extensively used in features under lib/services/auth/bloc and lib/views/**/bloc.
• No custom backend code: the app calls Supabase APIs directly.
README
• Confirms tech stack: Flutter + Supabase
• Mentions expansion plans for BLoC usage (already in place for many modules).
a. Main components
– Clients: Flutter UI running on Mobile (Android/iOS) and Desktop/Web (Windows, Linux, Web).
– Presentation layer: Flutter Views & Widgets (login, register, student_homepage, faculty_homepage, feature screens).
– Business logic layer: BLoCs (AuthBloc, AnnouncementHomepageBloc, EventsHomepageBloc, etc.).
– Service/Data layer: AuthProvider & SupabaseProvider communicate with Supabase.
– External backend: Supabase services (Authentication, Postgres Database, Storage, Real-time).
– Helpers & Utilities: Loading/Dialogs, Settings, SideDrawer.
b. Relationships & interactions
– Users interact with the Flutter UI.
– UI components dispatch Events to BLoCs.
– BLoCs process events, call Methods on Providers.
– Providers perform HTTP/Realtime requests to Supabase Auth & Database services.
– Supabase returns responses/updates which propagate back through Providers → BLoCs → UI streams.
c. Architectural patterns
– Layered architecture (Presentation → BLoC → Services → External).
– BLoC for state management, separating UI from business logic.
– Platform abstraction via Flutter engine for multi-OS support.
d. Key technologies & libraries
– Flutter & Dart
– flutter_bloc (BLoC pattern)
– supabase_flutter (Supabase integration)
– Platform SDKs (Android, iOS, Web, Windows, Linux)