How syedwajid01/ounotes works
Project type and purpose
• OU Notes is a Flutter-based mobile (and web) application for Osmania University students to browse, upload, download and report educational documents.
• It follows the “Stacked Architecture” (MVVM-like) on the client side and uses Firebase & other third-party services as its backend.
File structure
• Top-level:
• android/ and ios/ folders containing native build configurations and platform integration
• lib/ folder with the complete Flutter app
• assets/ and web/ for static assets (fonts, images, Lottie animations, HTML manifest)
• lib/ is subdivided into:
• app/ (service locator, router, logger)
• models/ (domain entities: Document, Syllabus, User, etc.)
• services/
– functional_services/ (Auth, Firestore, Cloud Storage, SharedPrefs, Email, etc.)
– state_services/ (ViewModel-backing services: NotesService, DownloadService, etc.)
• ui/
– views/ (screen widgets + viewmodels)
– widgets/ (dumb & smart reusable components)
• AppTheme/, CustomIcons/, enums/, misc/, utils/
• pubspec.yaml declares dependencies such as stacked, stacked_services, firebase_auth, firestore, shared_preferences, file_picker, url_launcher, etc.
Extracted insights from README
• Confirms use of Stacked (MVVM), service locator (get_it under the hood), and a router code-generator.
• Lists feature set (PDF viewer, download management, reporting, notifications, uploads).
• Shows that backend is entirely Firebase (Auth, Firestore, Storage, Analytics) plus email and local storage.
Detail level
• Every major folder as a module
• Interactions (e.g., “ViewModel → FirestoreService.fetchDocuments() → Firestore”)
• Router flow (e.g., Splash → Intro → Home → DocumentDetails)
• Don’t over-aggregate: break out both dumb_widgets and smart_widgets, functional_services vs state_services