Skip to content
View quran-web3's full-sized avatar
๐ŸŽฏ
Focusing
๐ŸŽฏ
Focusing

Block or report quran-web3

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Content in all repositories owned by your account will be closed.
Maximum 250 characters. Please donโ€™t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this userโ€™s behavior. Learn more about reporting abuse.

Report abuse
quran-web3/README.md

๐Ÿ“– Quran Web3 (Quran-Web3.NFT)

The Quran Web3 Project merges the teachings of the Quran with the potential of blockchain technology. It creates a decentralized platform where users can securely access Quranic translations, interpretations, and scholarly insights.


Platform: Polygon Storage: IPFS Browser: Brave / Opera


๐Ÿ“œ Whitepaper Summary: The Quran Web3 Project

The Quran Web3 Project represents a groundbreaking fusion of spiritual wisdom and cutting-edge Web3 technology. Below is a high-level summary of our vision, challenges, and technological solutions:

Mission & Vision

  • The project seeks to revolutionize how individuals access and engage with the Quran by introducing decentralization, transparency, and user-centric design.
  • It provides an inclusive, secure, and transparent platform that bridges the gap between tradition and innovation.
  • The platform empowers scholars, researchers, and enthusiasts to unite in exploring the depths of Quranic knowledge.

Technology & Preservation

  • Decentralized Storage: Quranic materials are distributed across a network of nodes, ensuring redundancy, data durability, and minimizing the risk of loss.
  • Data Security: State-of-the-art encryption guarantees that user data and sacred resources are protected from unauthorized access.
  • Immutable Records: The IPFS provides a tamper-proof record, ensuring the provenance and authenticity of translations and commentaries.

๐ŸŒŸ Core Pillars

Pillar Description
๐Ÿ” Transparency Immutable records on the blockchain verify the provenance and authenticity of Quranic resources.
๐ŸŒ Global Accessibility Transcends geographical boundaries and language barriers to promote deeper understanding worldwide.
๐Ÿ›ก๏ธ Decentralization Ensures global accessibility to Quranic resources, preserving data integrity and resisting censorship.

๐Ÿš€ Explore The Platform

  • ๐ŸŒ Web3 IPFS Quran with NFT Domain (Quran-Web3.NFT): Decentralized frontend hosted permanently across peer-to-peer nodes.
  • ๐Ÿ“„ 605 Pages Quran NFTs: Page-by-page digital preservation anchored on the blockchain.
  • ๐Ÿ“œ Complete Quran in Single NFT: The entire sacred text encapsulated within a single, immutable smart contract.

๐Ÿ’ก Recommended Browsers

For native Web3 domain resolution (.nft) and decentralized IPFS routing, we recommend using:

  • ๐Ÿฆ Brave Browser
  • ๐Ÿ”ด Opera Browser

โœจ Key Application Features

๐ŸŽจ 1. Modern Responsive UI & Visual Customization

  • Fully Responsive Design: Optimized for desktops, tablets, and mobile devices.
  • Light & Dark Theme Toggle: Switch between bright and dark (lights-off) reading modes for optimal comfort.

๐Ÿ“– 2. Dual Viewing Modes & Verse Controls

  • Page-by-Page View (Per Page): Authentic page-style layout with interactive verse options:
    • ๐Ÿ”Š Play: Verse-by-verse recitation audio.
    • ๐Ÿ“š Tafsir: Access verse explanations.
    • ๐Ÿ”– Bookmark: Instant progress marking.
    • ๐Ÿ”— Share & Copy: Quick copy of Arabic/translation text and links.
    • ๐Ÿ“ Personal Notes: Add custom study notes to any verse.
  • Surah View (Per Surah): Continuous chapter reading with an integrated Verse Repeater modal for memorization (Hifz).
+-------------------------------------------------------------+
|                      VERSE REPEATER                         |
+-------------------------------------------------------------+
| [Start Verse: 1]  --->  [End Verse: 7]                      |
| [Repeat Count: 3]                                           |
|                                                             |
|   [ โ–ถ Start Repeat ]                  [ โšโš Pause Repeat ]   |
+-------------------------------------------------------------+

๐Ÿ—“๏ธ 3. "Quran in a Year" Reading Program

  • 365-Day Completion Plan: 604 pages systematically divided (1โ€“2 pages/day) using a custom Python script powered by the Quran.com API.
  • Daily Target Card: Live widget displaying current day, Hijri date, target pages, and exact starting/ending verses.
  • Completion & Reset System: Celebratory screen on Day 365 with optional reset confirmation.

๐Ÿ”ค 4. 3 Quranic Text Display Modes

  1. Standard (Uthmanic Hafs): Clean physical Mushaf text (Quran.com).
  2. Tajweed (Indopak Naskh): Color-coded rules with interactive tooltips (Quran.com).
  3. Word-by-Word (WBW): Individual word breakdown with translations in 4 languages (Quranwbw.com) via (Quran.com).

๐ŸŒ 5. Multi-Language Translations (12 Languages)

Supports authentic translations sourced from Quran.com API :

  • ๐Ÿ‡ฌ๐Ÿ‡ง English | ๐Ÿ‡จ๐Ÿ‡ณ Chinese | ๐Ÿ‡ฎ๐Ÿ‡ณ Hindi
  • ๐Ÿ‡ช๐Ÿ‡ธ Spanish | ๐Ÿ‡ซ๐Ÿ‡ท French | ๐Ÿ‡ต๐Ÿ‡น Portuguese
  • ๐Ÿ‡ฉ๐Ÿ‡ช German | ๐Ÿ‡ฏ๐Ÿ‡ต Japanese | ๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesian
  • ๐Ÿ‡ง๐Ÿ‡ฉ Bengali | ๐Ÿ‡ท๐Ÿ‡บ Russian | ๐Ÿ‡ฐ๐Ÿ‡ท Korean

๐ŸŽง 6. Audio Recitations (6 Renowned Qaris)

Verse-by-verse audio powered by EveryAyah.com:

  • Sheikh Abdul Rahman Al-Sudais
  • Sheikh Abu Bakr Al-Shatri
  • Sheikh Fares Abbad
  • Sheikh Maher Al-Muaiqly
  • Sheikh Saad Al-Ghamdi
  • Sheikh Saud Al-Shuraim

๐Ÿ  7. Home Dashboard & Quick Navigation

  • Continue Reading Card: Instant resumption of your last session.
  • Verse of the Day Card: Daily inspirational verse module.
  • Multi-Tab Navigation: Fast switching between Surah, Verse, Juz, and Page.
  • Static Search Bar: Client-side search engine across chapters and verses.

๐Ÿ’พ 8. Decentralized Data Center

  • No Account Required: Client-side architecture with zero tracking or central databases.
  • Local Storage Persistence: All progress, notes, and preferences remain local.
  • Data Portability:
    • ๐Ÿ“ฅ Export All Data (Backup): Download your entire state as a .json file.
    • ๐Ÿ“ค Import Data (Restore): Seamlessly restore your reading state on any new device.

๐Ÿ› ๏ธ Tech Stack

Component Technology / Source
Frontend HTML5, Vanilla JavaScript (ES6+), W3.CSS
Blockchain Network Polygon
Hosting & Protocol Web3 Static / IPFS
Arabic Text Source Quran.com API
Word-by-Word Engine Quranwbw.com via Quran.com API
Audio Source EveryAyah.com

Pinned Loading

  1. quran-web3.github.io quran-web3.github.io Public

    HTML 1