The Holy Qur'an

Updated 2026-09-10. The maintained, in-depth documentation lives in docs/.

Application of Holy book of Muslims, Al-Qur'an. Developed using Flutter The data is fetched using API and now the offline mode is available. So, you need internet for the first time only!

📁 Download Now

Get it from Play Store

Watch the promo video here.

💻 Installation steps

Flutter 3.47.3 (Dart 3.13) pinned with FVM via .fvmrc
Android target/compile SDK 36, min SDK 24 · iOS 15+

git clone https://github.com/mhmzdev/the-holy-quran-app.git
cd the-holy-quran-app
fvm install
fvm flutter pub get
fvm flutter run

🧱 Tech stack

Flutter 3.47.3 / Dart 3.13 via FVM · state: flutter_bloc + provider + get_it
Data: alquran.cloud over Dio, cached offline with Hive CE; Freezed models — split into packages/al_quran_api (client, models, data provider, codegen) and packages/al_quran_repo (repositories)
Android: Kotlin DSL Gradle (AGP 9.1, Gradle 9.3), target/compile SDK 36, min SDK 24 · iOS: 15+, buildable but not published · Web: build currently broken

🛠 Development

fvm flutter analyze && fvm flutter test                          # gates before a PR
cd packages/al_quran_api && fvm dart run build_runner build      # after changing models
fvm flutter build appbundle --release                            # Play Store bundle (needs android/key.properties)
fvm flutter build apk --release                                  # sideload/test build

Project documentation (architecture, conventions, ADRs, domain notes, release process) lives in docs/. AI-agent guidance is in AGENTS.md with path-scoped rules and skills under .agents/.