How amirulirrfaan/iqalqalah works
Project type and purpose
• This is a cross-platform Flutter application (“iqalqalah”) whose goal is to teach Tajweed via notes, quizzes, and games.
• It targets Android, iOS, Web, Linux, macOS, and Windows (folders: android/, ios/, web/, linux/, macos/, windows/).
• Backend services are provided by Firebase (Firestore, Authentication, etc.).
File structure
• Top-level platform runners (android/, ios/, web/, linux/, macos/, windows/) host native shell code and plugin registrants.
• lib/ holds the entire Dart codebase:
– main.dart: app entry point
– firebase_options.dart: auto-generated Firebase config
– screens/: feature modules organized by domain (onboarding, dashboard, game, quiz, note, leaderboard, manage)
– theme/: centralized theming (app_theme.dart)
• assets/images/ and ios/Runner/Assets.xcassets: static resources
• Configuration files: pubspec.yaml, firebase.json, .firebaserc
Pull insights from the README
• Core tech stack: Flutter (Dart) + Firebase (Firestore for database, likely Firebase Auth, possibly Cloud Storage or Cloud Functions).
• Primary features: notes viewer, interactive quizzes, gamification (points, leaderboard), user customization.
Final reminders
• Every essential component (screens, theming, Firebase config, platform shells).
• Data flows for quizzes, notes retrieval, leaderboard updates, and user profile customization.
• Be precise but avoid unnecessary detail—focus on logical boundaries and interactions.