Iqra is a tool meant to allow Muslims to search the Quran using speech recognition. This repo contains the code for the Android client. There are also repos for the website and iOS client.

In order to run the app, open the project in Android Studio. Before performing a gradle sync, a few steps need to be taken. First, rename the sample-google-services.json file in the app directory to google-services.json. Next, create a file named gradle.properties in the project root directory. Copy the following line into the file:

IQRA_API_KEY=yourAPIKey

You'll need to replace the IQRA_API_KEY variable's value with a valid key. You can obtain a key for testing by sending an email to [email protected] with subject line "api key request". Please allow some time for your request to be processed and an api key sent back.

Once you've obtained an api key and placed it into gradle.properties, you can run a gradle sync and then run the app.

Contributions of patches and comments are welcome. If you'd like to contribute a new feature, create an issue for it first and only open a pull request once the feature request has been approved by the project owner.