IslamQA-for-Android

Native android application built on top of https://islamqa.org/.

View Demo · Report Bug · Request Feature . Project Management

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Native Android Application built with latest Android OS features. Just a frontend for IslamQA.org.

IslamQA.org is a repository of Islamic answers. They have collected over 93,950 Islamic Q&A from the official websites of various scholars and Islamic educational institutions around the world. You can find answers to your questions from different school of thoughts (madaahib) from the Sunni scholarship. So far, they have collected around 87,000 answers from Hanafi Fiqh, around 5,700 answers from Shafi’i Fiqh, around 270 answers from Maliki Fiqh, and around 280 answers from the Hanbali fiqh.

This app just scrapes this awesome website in the user-end, and shows the answers based on the preferred 'Madhab' of the user. Once loaded, it caches the data, to reduce load on the original website. This app incorporates latest Material You themeing, Clean Architecture recommended by Google, Kotlin Coroutines for multithreading and Work Manager for background syncing to give an immersive experience to the user.

(back to top)

Built With

Major frameworks this application is built around.

• Android SDK
• Kotlin Coroutines, for multithreading.
• skrape.it, for web scraping.

(back to top)

Getting Started

This app needs no extra credential as it has no internal API or Firebase connection.

Prerequisites

• Android Studio Chipmunk (Download link)
• Java-OpenJDK 11+
  • For macOS

    brew install openjdk@11
  • For Windows

     choco install openjdk11
  • For Linux

     pacman -S jdk11-openjdk
• Android SDK Version 32

Installation

1. Clone the repo

   git clone https://github.com/kabirnayeem99/islam_qa_org_android.git
2. Build the project

   ./gradlew build

(back to top)

Demo

(back to top)

Roadmap

• Load Random questions in a slider
• Load Fiqh-based questions in the home page
• Load Answers with the relevant question list.
• Offline first designs with background syncing.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Naimul Kabir - @kabirnayeem99 - kabirnayeem.99@gmail.com

(back to top)

Acknowledgments

• skrape.it
• Shimmer Effect for Android
• Timber

(back to top)