How astarub/campus_app works
Main Components
• Mobile Client (Flutter App)
– Presentation Layer (UI pages, widgets under lib/pages & lib/utils/widgets)
– Domain Layer (UseCases under lib/pages/*/…_usecases.dart)
– Data Layer
· Repositories (lib/core/backend_repository.dart, lib/pages/*/…_repository.dart)
· Data Sources (HTTP clients under lib/pages/*/…_datasource.dart, lib/core/backend)
· Entities & Mappers (…_entity.dart & generated serializers)
– Core Services & Utilities (DI in lib/core/injection.dart, settings, themes, l10n, dio_utils)
– Platform Plug-ins (Firebase, Google-Services—firebase_options.dart, android/app/google-services.json, iOS Podfile)
– Assets & Localization (assets/animations, fonts, img; l10n arb files)
• Backend Services
– Campus-App Backend (custom APIs for user data, timetable, rubnews, wallet)
– Mensa Scraper (scrapes cafeteria menus; uptime badge in README)
– Forgerock Auth Service (OAuth/OpenID; documented in docs/wiki/Utilities/forgerock_api.md)
– Moodle API (student information; docs/wiki/Utilities/moodle_api.md)
– RubNews Feed (news XML endpoint; docs/wiki/Pages/rubnews.md)
• Third-Party & Cloud
– Firebase (Analytics, Crashlytics, possibly Messaging)
– Google-Services (iOS/Android configuration)
Relationships & Data Flows
• User taps UI → Presentation Layer
• Presentation calls Domain UseCase → uses Repository interface
• Repository delegates to DataSource → HTTP calls via Dio (lib/utils/dio_utils.dart)
• DataSource calls appropriate backend (Campus Backend, Mensa Scraper, etc.)
• Responses deserialized into Entities → passed back up to Presentation
• DI Container wires UseCases, Repositories, DataSources at app startup (main.dart → injection.dart)
• Localization subsystem loads l10n/*.arb based on user locale
• Assets (animations, fonts) loaded by UI widgets
Architectural Patterns & Principles
• Layered/Onion Architecture: Presentation → Domain → Data
• Clean Architecture with UseCases and Repositories
• Dependency Injection (singletons wired in lib/core/injection.dart)
• Code generation for serialization (built_value or json_serializable via *.g.dart)
• Platform abstraction via Flutter plugins (Firebase, native Android/iOS code in android/app & ios/Runner)
Technologies & Frameworks to Annotate
• Flutter & Dart (lib/, android/, ios/, web/)
• Dio for HTTP
• json_serializable (generated *.g.dart)
• Forgerock Auth, Moodle API clients
• Firebase SDK (Crashlytics, Analytics)
• Gradle (Android), CocoaPods (iOS)
Final Checklist
• Clear labels (e.g., “CalendarUseCase,” “MensaDataSource,” “Firebase Crashlytics”)