QuranEngine

QuranEngine is the open-source iOS library that powers the Quran.com iOS App. This repository contains approximately 99% of the Quran.com iOS App code, providing you with a robust foundation to build Quran-related applications.

In this repository, we also provide an example application called QuranEngineApp that mimics the Quran.com iOS App, available under the Example folder.

Installation

The repository can be installed via Swift Package Manager:

.package(url: "https://github.com/quran/quran-ios", branch: "main")

Then use one or more of the available targets as dependency. All targets are available for consumers, for example:

.product(name: "AppStructureFeature", package: "quran-ios"),

⚠️ Please note that we do not support CocoaPods or Carthage, and we do not plan to support these in the future.

Repository Structure and Architecture

The library consists of 6 top-level directories:

Core: General purpose libraries that work with any app. The only exception is the Localization library, which we aim to make more universal.
Model: Contains simple entities that facilitate building a Quran App. These entities mostly work together without including extensive logic.
Data: This directory includes SQLite, CoreData, and Networking libraries that abstract away the underlying technologies used.
Domain: This is where the business logic of the app resides. It depends on Model and Data to serve such business logic.
UI: Houses the design system used by the App (we call it NoorUI). We are gradually shifting towards using SwiftUI in all our components, except for the navigation aspect - we will continue using UIKit for that. UI does not depend on Domain nor Data, but can depend on Core and Model.
Features: Comprises the screens making up the app. They rely on all other components to create our Quran apps. Features can encompass other features to create higher-level features. For example, AppStructureFeature hosts all other features to create the app.

⚠️ UI and Features do not yet contain tests, and makes up around 50% of the source code. We are keen on adding tests to them in the future inshaa'Allah.

Here is a visual representation of the architecture:

This dependency order is enforced in Package.swift.

Contributions

We warmly welcome contributions to the QuranEngine project. We encourage potential contributors to tackle any of the open issues. Please start a conversation with us in the Discussions section of the repo and we will do our best to assist you inshaa'Allah.

If your contribution is small enough, feel free to create a Pull Request directly. For larger contributions, we ask that you first create a post in the discussions section. This allows us to ensure that nobody else is working on the same feature, and also allows us to plan for upcoming features in case your contribution is dependent on another feature.

Intended Use

We are re-open sourcing the app because we see a lot of benefits in allowing developers to build on top of what we have already built. This way, developers don't have to re-implement the foundation and can innovate more on the idea itself. The malicious behavior we've seen previously, including but not limited to selling this free code to people who are not aware of this repo's existence, is negligible compared to the overall benefit of giving what we have implemented to others. We look forward to seeing great Islamic innovation that helps Muslims everywhere inshaa'Allah.

We welcome all types of use. However, we kindly ask that you don't use the QuranEngineApp example and republish it without making any modifications. You may also need to bring your own data.

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.