How abhishekkx/army-institute-of-law-exam-app works
Project type and purpose
• This is a cross-platform mobile application built with Flutter/Dart.
• Purpose: Provide a practice-test environment for the Army Institute of Law entrance exam, with four timed sections, dynamic question loading via the Gemini API, offline fallbacks, immediate feedback, and responsive UI.
File structure
Top-level folders and files:
• android/ – Native Android project and Gradle build scripts for embedding the Flutter engine.
• lib/ – Main Dart code:
– main.dart: App entrypoint, API key config, runApp()
– models/: Data classes (e.g., Question)
– services/: Business logic, API integration (GeminiService) & mock fallback
– widgets/: UI components (QuestionWidget, SidebarWidget, etc.)
• test/: Widget tests
• pubspec.yaml / pubspec.lock: Flutter dependency management
• README.md: Project overview, features, setup, usage
README for additional insights
• Tech stack: Flutter SDK, Dart, flutter_gemini package, Material widgets, built-in StatefulWidget state management
• Architecture hints: Separation between UI (widgets), domain (models), and service (Gemini API + fallback logic)
• Key features: real-time question fetching, error retries, offline mode, timed sections, sidebar navigation
Components
a. Main components
• Mobile Device (iOS/Android) running the Flutter App
• Flutter Framework & Dart VM
• Presentation Layer: Widgets (StartScreen, QuizScreen, Sidebar, ScorecardDialog)
• State Management: StatefulWidgets managing UI state, timers, current question index
• Domain Layer: Question model, Section manager
• Service Layer:
– GeminiService: HTTP client to Gemini 2.0 Flash API, retry logic, JSON parsing
– MockQuestionProvider: Returns offline fallback questions
• Data Storage (optional): In-memory caches, local persistence if implemented
• External Service: Gemini API endpoint
• Native Android Host: Gradle scripts and AndroidManifest for app packaging
b. Relationships and interactions
1. User taps “Start Test” → Presentation layer triggers Service Layer to fetch first batch of questions.
2. GeminiService makes REST calls → receives JSON → maps to Question models → caches in memory.
3. On failure after retries → MockQuestionProvider returns fallback questions.
4. Presentation widgets consume Question models, render choices, handle user input.
5. Selection event → UI state updates (correct/wrong coloring) → state machine advances to next question.
6. SidebarWidget queries Section manager for current progress and allows jumps.
7. Timer in Presentation layer updates UI; on expiration triggers end-test flow → ScorecardDialog.
8. Native Android host/Flutter engine provides device capabilities (network, timers).
c. Architectural patterns and principles
– Layered architecture: Presentation → Domain → Service → External API
– Separation of concerns: UI code in widgets, pure data in models, async logic in services
– Fail-fast with retry and fallback (Circuit-Breaker style for API calls)
– Responsive design using MediaQuery/LayoutBuilder
d. Key technologies/frameworks/libraries
– Flutter SDK & Material Design widgets
– Dart language constructs (StatefulWidget, async/await)
– flutter_gemini package for Gemini API integration
– Gradle/Kotlin DSL for Android build
– JSON serialization (built-in or via package)