README.md

QuranEngine

QuranEngine is the engine powering the Quran.com iOS app. It's a collection of libraries that can be used to create a Quran app or a quran reading/listening experience within an Islamic app.

• QuranEngine
  • Libraries
    • QuranKit
    • QuranTextKit
    • QuranMadaniData
    • QuranAudioKit
  • Libraries to Open Source Soon
    • QuranBookmarkingKit
  • Installation
    • Swift Package Manager
  • Contributions
  • License

Libraries

We have currently open sourced the following libraries:

QuranKit

A quranic numbering library. It can be used to locate the page of a verse or juz' of a page, etc.

QuranTextKit

A quranic text kit to search and retrieve quran, translations and tafseers text.

QuranMadaniData

The data for the madani Quran.

QuranAudioKit

A library for downloading and playing quran recitations.

Libraries to Open Source Soon

The following are libraries we are going to open source soon.

QuranBookmarkingKit

A library for taking bookmarks and notes.

Installation

Swift Package Manager

let package = Package(
    name: "<YOUR PACKAGE>",
    products: [
        .library(name: "<YOUR PACKAGE>", targets: ["Caching"]),
    ],
    dependencies: [
        .package(name: "QuranEngine", url: "https://github.com/quran/quran-ios", .from("2.0.1")),
    ],
    targets: [
        .target(
            name: "<YOUR PACKAGE>",
            dependencies: [
                .product(name: "QuranKit", package: "QuranEngine"),
                .product(name: "QuranTextKit", package: "QuranEngine"),
                .product(name: "QuranMadaniData", package: "QuranEngine"),
                .product(name: "QuranAudioKit", package: "QuranEngine"),
            ]
        ),
    ]
)

It would be great if you could send an e-mail to [email protected] then we will notify you for beta builds and you can then help us find bugs before going live.

Contributions

Please read Contributions page.

License

• QuranEngine is available under Apache-2.0 license. See the LICENSE file for more info.
• Madani images from quran images project on github.
• Translation, tafsir and Arabic data come from tanzil and King Saud University.