---
**Huda** is a comprehensive Flutter-based Islamic companion application designed to help Muslims practice their faith with ease and convenience. The app provides essential Islamic tools, resources, and features to support daily worship and spiritual growth.
## π Table of Contents
* [Screenshots](#-screenshots)
* [Quick Start](#-quick-start)
* [Key Features](#-key-features)
* [Contributing](#-contributing)
* [License & Contact](#-license--contact)
---
## πΈ Screenshots
| Home | Quran Reader | Prayer Times |
| ------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|  |  |  |
| Qiblah Compass | Islamic Reminder | Daily Checklist |
| ------------------------------------------------------- | --------------------------------------------------- | ----------------------------------------------------- |
|  |  |  |
---
## π Quick Start
### Prerequisites
* **Flutter SDK:** `3.44.7` (pinned in `.fvmrc`)
* **Dart SDK:** Bundled with the pinned Flutter SDK
* **Android builds:** JDK 17, Android SDK Platform 37.0, and Build Tools 37.0.0
### Installation
#### 1. Clone the repository
```bash
git clone https://github.com/abdulwahed-s/Huda.git
cd Huda
```
#### 2. Install dependencies
```bash
flutter pub get
```
#### 3. Configure Firebase *(Optional but Recommended)*
1. Create a Firebase project and register your applications.
2. Place `google-services.json` inside:
```text
android/app/
```
3. Place `GoogleService-Info.plist` inside:
```text
ios/Runner/
```
4. Configure your API keys in:
```text
lib/core/keys/hadith_key.dart
```
For more information, see:
https://github.com/abdulwahed-s/Huda/issues/1
#### 4. Run the application
```bash
flutter run
```
---
## π Key Features
### π Quran Reading & Study
* Complete Quran with authentic Uthmanic script
* Multiple translations and Tafsir support
* Audio recitations with offline playback
* Smart reading position tracking
### π Prayer Times & Adhan
* Accurate location-based prayer times
* Adhan notifications and countdown timers
* Multiple calculation methods
### π§ Qiblah Compass
* Accurate Qiblah direction
* Smooth animations with haptic feedback
### πΏ Digital Tasbih
* Persistent Dhikr counter
* Notes and tracking support
### π€² Athkar & Duas
* Categorized daily supplications
* Audio pronunciation support
### β
Islamic Daily Checklist
* Track prayers and habits
* Hijri calendar integration
* Daily streak tracking
### π€ Huda AI Assistant
* AI-powered Islamic Q&A assistant
* Responses based on authentic Sunni sources, Quran, and Hadith
### π Hadith & Islamic Library
* Curated Islamic books and Hadith collections
* Built-in offline PDF reader
### π± Home Screen Widgets
* Quick access to prayer times and core features
### π Multilingual Support & Themes
* RTL Arabic support
* Dynamic language switching
* Dark and Light themes
---
## π€ Contributing
Contributions are always welcome and greatly appreciated.
Whether you're fixing bugs, improving performance, adding features, or translating content, your support helps make Huda better for the Ummah.
### How to Contribute
1. Fork the repository
2. Create a new branch
```bash
git checkout -b feature/amazing-feature
```
3. Commit your changes
```bash
git commit -m "Add amazing feature"
```
4. Push to your branch
```bash
git push origin feature/amazing-feature
```
5. Open a Pull Request
> Please ensure all contributions align with authentic Islamic principles and the purpose of the application.
---
## π License & Contact
This project is licensed under the **MIT License**.
See the [LICENSE](LICENSE) file for more information.
### π Bug Reports & Feature Requests
Please use [GitHub Issues](https://github.com/abdulwahed-s/Huda/issues) to report bugs, request features, or share suggestions.
---
## π€² Islamic Disclaimer
> Huda is designed to assist Muslims in worship, learning, and daily practice.
>
> While we strive to provide authentic and accurate Islamic content, users are encouraged to consult qualified scholars for religious guidance and important matters.
>
> The AI assistant provides responses based on established Islamic sources and should not replace knowledgeable scholars or trusted religious authorities.
---
### May Allah ο·» accept this work and make it beneficial for the Ummah. Ameen.
> *βAnd whoever does righteous deeds, whether male or female, while being a believer β those will enter Paradise and will not be wronged, even as much as the speck on a date seed.β*
> **β Quran 4:124**
# Huda - Islamic Companion App
