How marcusng/flutter_riverpod_quiz works
Project Type & Purpose
• It’s a cross-platform mobile application (Flutter) that presents quiz questions to users.
• It uses Riverpod for state management and follows a repository-based data layer.
File Structure
• Top-level mobile platforms:
– android/… (Gradle files, native Android boilerplate)
– ios/… (Xcode project, Swift AppDelegate, asset catalogs)
• lib/… (Dart code) broken into:
– controllers/quiz (QuizController, QuizState)
– enums (difficulty levels)
– models (Question, Failure)
– repositories/quiz (abstract BaseQuizRepository, concrete QuizRepository)
– main.dart (app entry point, provider scope)
• test/widget_test.dart (UI smoke test)
• pubspec.yaml (dependencies: flutter_riverpod, http, etc.)
Key README Insights
• No backend code in repo – likely calls an external trivia API (via QuizRepository).
• State managed with Riverpod providers in controllers.
Main Components
a. Presentation Layer (UI Widgets)
– Screens: Quiz screen, loading/error views
– Riverpod ConsumerWidgets or WidgetRefs
b. State Management Layer
– QuizController (StateNotifier/StateNotifierProvider)
– QuizState (holds loading, questions, error)
c. Domain/Data Layer
– QuizRepository interface (BaseQuizRepository)
– QuizRepository implementation (makes HTTP calls)
– Models: QuestionModel, FailureModel
– Enums: Difficulty
d. External Service
– Remote Trivia API (REST endpoint)
e. Platform Runtime
– Flutter Engine on Android & iOS
Relationships & Data Flow
1. UI Widget dispatches an event (e.g., “startQuiz”) via Riverpod provider.
2. QuizController receives the event, sets state to loading.
3. Controller invokes QuizRepository.fetchQuestions(difficulty).
4. Repository issues HTTP request to external Trivia API.
5. API returns JSON → parsed into List<QuestionModel> or Failure.
6. Controller updates QuizState with success or failure.
7. UI rebuilds based on new state.
Architectural Patterns & Principles
• Layered/Clean Architecture:
– UI → State (Riverpod) → Repository → External API
• Separation of concerns: UI logic vs. state logic vs. data logic
• Dependency inversion via abstract BaseQuizRepository
Technologies & Frameworks
• Flutter (Dart) – UI toolkit
• flutter_riverpod – state management
• http (or similar) – network calls
• StateNotifier/StateNotifierProvider – for controllers
• JSON serialization (manual or built_value/freezed)