QuranEngine

2.0.0

QuranEngine is the engine powering the Quran.com iOS app.
quran/quran-ios

What's New

QuranEngine 2.0.0

2022-01-01T18:41:57Z

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.

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.

Libraries to Open Source Soon

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

QuranMadaniData

The data for the madani Quran.

QuranAudioKit

A library for downloading and playing quran recitations.

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(url: "https://github.com/quran/quran-ios", .from("2.0.0")),
    ],
    targets: [
        .target(
            name: "<YOUR PACKAGE>",
            dependencies: [
                .product(name: "QuranTextKit", package: "quran-ios"),
            ]
        ),
    ]
)

It would be great if you could send an e-mail to ios@quran.com 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

Description

  • Swift Tools 5.5.0
View More Packages from this Author

Dependencies

Last updated: Thu Mar 23 2023 11:18:42 GMT-0500 (GMT-05:00)