An open API service indexing awesome lists of open source software.

https://github.com/mahmud035/quran-mazid---api

This repository contains the code for the Quran Mazid API and a responsive website. The application provides easy access to the Holy Quran's text and translations.
https://github.com/mahmud035/quran-mazid---api

bootstrap5 css3 html5 js rest-api

Last synced: 11 months ago
JSON representation

This repository contains the code for the Quran Mazid API and a responsive website. The application provides easy access to the Holy Quran's text and translations.

Awesome Lists containing this project

README

          

# Quran Mazid - API

- **Live Site URL**: [Quran Mazid](https://quran-mazid-app.netlify.app/)

## Description

This repository contains the code for the Quran Mazid API and a responsive website. The application provides easy access to the Holy Quran's text, translations, and tafsir (exegesis). The website is built using HTML, CSS, and JavaScript to offer a comprehensive and user-friendly resource for Islamic studies and personal use.

## Features

- **Quranic Text**: Access the original Arabic text of the Quran.
- **Translations**: Retrieve translations of the Quran in Bengali.
- **Tafsir**: Get detailed explanations and interpretations of Quranic verses.
- **Surah and Ayah Search**: Search for specific Surahs (chapters) and Ayahs (verses).
- **Responsive Design**: Optimized for efficient and quick responses to API requests and ensures a seamless user experience across all devices.
- **Bookmarking**: Mark favorite Surahs for quick access.
- **Audio Playback**: Listen to the recitation of Quranic verses.

## Technologies Used

- **HTML**: Structure of the website.
- **CSS**: Styling and layout.
- **JavaScript**: Adds interactivity and enhances the user experience.
- **Bootstrap**: Used for responsive design and components.

## Usage

**Search Surah**: Use the search bar to find Surahs by name.

**View Surah Details**: Click on a Surah to view detailed information, including Arabic text, translation, and tafsir.

**Bookmark**: Click the heart icon to bookmark favorite Surahs.

**Filter**: Sort Surahs by serial, alphabet, or total ayah count.

**Play Audio**: Click the play icon to listen to the recitation of verses.

## Getting Started

### Prerequisites

- A web browser to view the website.
- A code editor like VS Code to make changes to the code.

### Installation

1. **Clone the Repository**:
```bash
git clone https://github.com/mahmud035/Quran-Mazid---API.git
```
2. **Open the Project**: Open the project in your preferred code editor to explore and modify the code.

3. **Run the Project**: Open the index.html file in your browser to view the website.

### Project Structure

**index.html**: The main HTML file for the website.

**css/style.css**: The main stylesheet for the website.

**js/script.js**: The main JavaScript file for handling interactivity and API integration.