https://github.com/coderbdk/al-quran
Al-Quran App – Read, listen, and learn the Quran with an interactive experience. Featuring word-by-word highlighting, Tajweed colors, bookmarks, and more.
https://github.com/coderbdk/al-quran
al-quran android-app jetpack-compose kotlin
Last synced: 3 months ago
JSON representation
Al-Quran App – Read, listen, and learn the Quran with an interactive experience. Featuring word-by-word highlighting, Tajweed colors, bookmarks, and more.
- Host: GitHub
- URL: https://github.com/coderbdk/al-quran
- Owner: CoderBDK
- Created: 2025-03-11T08:37:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T06:30:25.000Z (3 months ago)
- Last Synced: 2025-03-12T07:27:36.794Z (3 months ago)
- Topics: al-quran, android-app, jetpack-compose, kotlin
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Al-Quran App
🌟 This is a **Quran learning and reading app** that allows users to read, learn, and listen to the Quran efficiently.
## ✨ Features
- ✅ **Quran Reading & Listening**: Seamless reading and audio support.
- ✅ **Bookmark**: Save an Ayah as a bookmark and quickly access it later
- ✅ **Multi-Language Support**: Read and learn in multiple languages.
- ✅ **Search**: Easily search for specific surahs, verses, or words.
- ✅ **Level-Based Learning**: Unlock new levels as you progress.
- ✅ **Secure Backup & Restore**: Keep your data safe and private.
- ✅ **Tajweed Colors**: Color-coded text for proper recitation.
- ✅ **Word Highlighting**: Syncs word highlighting with audio playback for better focus.
- ✅ **Smooth UI with Jetpack Compose**: Clean and user-friendly interface.
- ✅ **Dynamic Content from Server**: Real-time updates.
## 📲 Installation Guide
### 📽️ How to Install the App?
Watch the video below to learn how to install the Al-Quran app on your device ⬇️
### 📝 **Step-by-Step Installation Guide**
#### 1. **Download APK & App Data**
- Click the link below to download the latest APK file for the app:
- [Download APK](https://github.com/CoderBDK/Al-Quran/releases/download/v1.0.0/al-quran-v1.0.0.apk)
- [Download App Data](https://github.com/CoderBDK/Al-Quran/releases/download/v1.0.0/al_quran_data-v1.0.0.qdf)
#### 2. Enable **Unknown Sources** in settings
To install the APK, you first need to allow your phone to install apps from unknown sources.
- **Step 1**: Go to **Settings** on your device.
- **Step 2**: Scroll down and tap on **Security**.
- **Step 3**: Under **Security**, tap on **Install unknown apps** (or **Unknown Sources** depending on your device).
- **Step 4**: Find the app (e.g., your browser or file manager) you will use to open the APK file. Toggle **Allow from this source** to enable it.
#### 3. Install the APK
Once you've enabled unknown sources:
- **Step 1**: Locate the downloaded APK file (usually in your **Downloads** folder).
- **Step 2**: Tap on the APK file to begin the installation.
- **Step 3**: A prompt will appear asking for permission to install the app. Tap **Install** to continue.
#### 4. Backup Key
To restore your data, follow these steps:
1. **Copy the Backup Key**:
```bash
wbkMmmHcVI5WMeA97w/beBH81ewm3+W9vf21vIF0XXs=
```
2. **Restore Data**:
- Go to the **User Create** option and click on the **Backup & Restore** icon button.
- In the **Input Field**, paste the copied **Backup Key**.
- Tap the **Restore** button.
- Choose the backup file `al_quran_data.qdf` that you downloaded earlier.
- Once the file is selected, the restore process will begin. Wait for it to complete.
- After the restore is complete, navigate back to the previous screen.
- Tap on the profile icon button in the **User Create Screen**, choose the user and Continue.
- Now you can start using the app with your restored data!
#### 5. Open the App
After installation is complete, you can tap **Open** to launch the app.
---
## 🎨 Resources Used
The following resources are utilized in this app:
- **Quran Data**:
- [Quran Data in JSON Format](https://github.com/risan/quran-json/blob/main/dist/quran_bn.json)
- **Surah Name Font**:
- [Quran Karim 114 Font](https://www.fontget.com/font/quran-karim-114/)
- **Quran Ayah Fonts**:
- [Muhammadi Quranic Font (TTF)](https://urdunigaar.com/download/muhammadi-quranic-font-ttf-file-download/)
- [Ayat Quran Font](https://www.fontspace.com/ayat-quran-286-font-f111904)
- [KFGQPC Uthmanic Script Hafs Regular Font](https://arabicfonts.net/fonts/kfgqpc-uthmanic-script-hafs-regular)
- **Tajweed Quick Guide**:
- [A Quick Guide to Tajweed](https://www.getquranic.com/a-quick-guide-to-tajweed/#Noon_Sakinah_Tanween)
- **Al-Quran Qaida**:
- [Tarteel-ul-Quran Qaida (English)](https://files.alislam.cloud/pdf/English-Qaida-Tarteel-ul-Quran.pdf)
- **Arabic Unicode Chart**:
- [Arabic Unicode Charts](https://www.unicode.org/charts/PDF/U0600.pdf)
- **Quran Align**:
- [Quran Align GitHub Repository](https://github.com/cpfair/quran-align)
- **Quran Audio**:
- Provided by [alquran.cloud API](https://alquran.cloud/api)
---
## 🛠 Tools Used
- **Jetpack Compose** - UI Development
- **Room Database** - Local Storage
- **Hilt (Dagger)** - Dependency Injection
- **Retrofit** - API Calls
- **OkHttp** - Networking
- **Gson** - JSON Parsing
## 📜 License
This app is released under the MIT License. See the [LICENSE](LICENSE) file for details.
---
If you have any feedback or issues, feel free to report them in the **Issues** section. Thank you for using the Al-Quran App! 😊