https://github.com/fcat97/QuranApi

A small API to add Quran with Tajweed Color in Android App
https://github.com/fcat97/QuranApi

android android-api android-library quran quran-api quran-tajweed

Last synced: 12 days ago
JSON representation

A small API to add Quran with Tajweed Color in Android App

• Host: GitHub
• URL: https://github.com/fcat97/QuranApi
• Owner: fcat97
• License: lgpl-3.0
• Created: 2021-09-02T06:54:59.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-11T06:59:36.000Z (over 1 year ago)
• Last Synced: 2024-07-11T09:22:12.973Z (over 1 year ago)
• Topics: android, android-api, android-library, quran, quran-api, quran-tajweed
• Language: Kotlin
• Homepage:
• Size: 4.43 MB
• Stars: 14
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog
  • License: LICENSE

Awesome Lists containing this project

• awesome-islamic-open-source-apps - QuranApi

README

          
![Quran Api](https://github.com/fCat97/QuranApi/blob/main/images/cover.png?raw=true)

# QuranApi [![](https://jitpack.io/v/fcat97/QuranApi.svg)](https://jitpack.io/#fcat97/QuranApi)

A simple Api to implement Quran in Android.

## Add To Project

**Step 1.** Add the JitPack repository to your build file

Add it in your root build.gradle at the end of repositories:

```gradle

allprojects {

    repositories {

        ...

        maven { url 'https://jitpack.io' }

    }

}

```

**Step 2.** Add the dependency. `version:` [![](https://jitpack.io/v/fcat97/QuranApi.svg)](https://jitpack.io/#fcat97/QuranApi)

```gradle

dependencies {

    implementation 'com.github.fcat97:QuranApi:version'

}

```

If the only need is to add tajeeed colors, use the [TajweedApi](https://github.com/fcat97/tajweedApi): `version:` [![](https://jitpack.io/v/fcat97/tajweedApi.svg)](https://jitpack.io/#fcat97/tajweedApi)

```gradle

dependencies {

    implementation 'com.github.fcat97:tajweedApi:version' // core parser

    implementation 'com.github.fcat97:tajweedApi-android:version' // for android target

}

```

## How to Use?

You can use as you wish. Here is a sample usage shown

```kotlin

val recyclerView = findViewById(R.id.textView)

val adapter = Adapter()

recyclerView.adapter = adapter

val api = QuranApi(this)

api.getSurahAsync(2) { adapter.submitList(it.verses) }

```

For details see the [How To](wiki/howTo.md) page.

A fully functional app source is included in this repo.

>

Feel free to fork and update. Just give me a PR...