Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 97 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,97 @@
# 📊 Project: Complex API

### Goal: Use data returned from one api to make a request to another api and display the data returned

### How to submit your code for review:

- Fork and clone this repo
- Create a new branch called answer
- Checkout answer branch
- Push to your fork
- Issue a pull request
- Your pull request description should contain the following:
- (1 to 5 no 3) I completed the challenge
- (1 to 5 no 3) I feel good about my code
- Anything specific on which you want feedback!

Example:
```
I completed the challenge: 5
I feel good about my code: 4
I'm not sure if my constructors are setup cleanly...
```
# 🕋 **Quranify**

### ✨ *“Read. Reflect. Remember.”*

Quranify is a minimalist web app that lets users **search, listen, and read** verses from the Qur’an — with both **Arabic recitation** and **English translation** displayed side by side.
It’s designed to make connecting with the Qur’an intuitive, beautiful, and accessible on any device.

---

## 🎯 **Goal**

To combine the power of **two APIs** — one for Arabic recitation and another for English translation — into a single seamless experience where users can:

* Enter a **surah** and **verse number**
* Instantly view the verse in Arabic
* Hear the recitation
* Read the English translation below

---

## ⚙️ **Features**

* 📖 Retrieve any verse by chapter and verse number
* 🔊 Play & pause audio recitations (`Mishary Alafasy`)
* 🌍 View English translation (`Mustafa Khattab - The Clear Quran`)
* ⚡ Fast API chaining between two Qur’an data sources
* 🎨 Simple and clean UI optimized for reflection
* 📱 Fully responsive layout (mobile-ready)

---

## 🧠 **How It Works**

1. The app uses **AlQuran.cloud API** for Arabic text and audio:
`https://api.alquran.cloud/v1/ayah/{surah}:{ayah}/ar.alafasy`
2. It then fetches the **translation** using Fawaz Ahmed’s GitHub-hosted Quran API:
`https://cdn.jsdelivr.net/gh/fawazahmed0/quran-api@1/editions/eng-mustafakhattaba/{surah}/{ayah}.min.json`
3. The verse, translation, and recitation are displayed dynamically in the interface.

---

## 🧩 **Tech Stack**

| Area | Technology |
| -------------- | -------------------------------------------- |
| **Frontend** | HTML, CSS, JavaScript |
| **APIs Used** | Al-Qur’an Cloud API, Fawaz Ahmed’s Quran API |
| **Icons** | Font Awesome |
| **Deployment** | GitHub Pages |

---

## 🚀 **How to Run Locally**

1. **Clone this repository**

```bash
git clone https://github.com/abdirxhmxn/quranify.git
```
2. **Open the project folder**

```bash
cd quranify
```
3. **Run the app**
Open `index.html` directly in your browser — no server setup needed.

---

## 🌐 **Live Demo**

> 🔗 [Quranify on GitHub Pages](https://abdirxhmxn.github.io/Quranify/)
---

## 🧭 **Future Enhancements**

* 🔍 Search by keyword or theme (e.g., “mercy,” “patience”)
* 🕰️ Recitation playlist with auto-play through surahs
* 🧘‍♂️ Tafsīr integration for deeper study
* 💾 Local storage for saving favorite verses
* 🌙 Dark mode toggle

---

## 💬 **About the Creator**

Created by **Abdirahman Mohamed (MC)** —
a software engineer and educator passionate about building meaningful tools that blend **faith and technology**.

> “Quranify isn’t just code — it’s a bridge between hearts and revelation.
> Every verse should feel close, audible, and alive.”

---

## 🕊️ **License**

This project is open source and distributed under the **MIT License**.
Loading