kh3rld/Qverse

★ 0Forks 0TypeScriptGitHub ↗Compare

Project website ↗

quran

README

QuranVerse Explorer

QuranVerse Explorer is a modern, mission-driven web application designed to help users connect deeply with the Quran. It provides a clean, intuitive, and inspiring interface for searching, reading, and reflecting on Quranic verses. This project is built with technical excellence, scalability, and user experience at its core, aiming to be a genuine contribution to the digital Quran ecosystem.

Vision & Purpose

Our vision is to leverage technology to make the wisdom of the Quran more accessible and engaging for a global audience. QuranVerse Explorer is not just a coding exercise; it is a tool for spiritual growth and learning. We aim to provide a beautiful, performant, and reliable platform that people can genuinely use in their daily lives to foster a stronger connection with the Quranic text.

Features

  • Verse Search and Exploration: Search the Quran by keyword, Surah (chapter), or Juz (part) with a fast, intuitive interface.
  • Rich Reading Experience: Read verses in their original Arabic script alongside high-quality English translations and tafsir (commentary).
  • Personal Verse Collection: Save meaningful verses to a personal "Favorites" collection for easy access and review.
  • Reflection Notes: Write and save personal reflections tied to specific verses to deepen understanding and engagement.
  • AI-Powered Daily Verse: Discover a new, inspiring verse each day, personalized based on your interactions and reflections.
  • Dark & Light Modes: Switch between themes for comfortable reading in any lighting condition.
  • Responsive Design: A seamless experience across all devices, from mobile phones to desktops.

Technical Stack & Design

  • Frontend: Next.js (App Router), React, TypeScript
  • Styling: Tailwind CSS with a custom, spiritually-inspired theme. Animations by Framer Motion.
  • Backend/API: Integration with the public Quran.com API (v4).
  • State Management: React Hooks & Context API for lightweight, powerful state management.
  • Data Persistence: Browser localStorage for persisting user favorites and reflection notes.
  • Deployment: Optimized for deployment on Vercel.

Optimizations & Scalability

  • Next.js App Router: Utilizes React Server Components (RSC) to minimize client-side JavaScript and improve initial page load times.
  • Data Caching: Leverages Next.js's built-in fetch caching to reduce API calls and speed up data retrieval.
  • Component-Based Architecture: A modular structure makes the application easy to maintain, test, and scale.
  • Efficient State Management: Uses React's native capabilities to avoid the overhead of heavy third-party state management libraries.

Setup & Installation

To run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/kh3rld/Qverse
    cd Qverse
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev

    The application will be available at http://localhost:9002.

  4. Build for production:

    npm run build
    npm start

Future Improvements

  • Multiple Translations & Tafsirs: Allow users to choose from a wider range of translations and commentaries.
  • Audio Recitations: Integrate verse-by-verse audio recitations from various Qaris.
  • User Accounts: Introduce optional cloud-based user accounts to sync favorites and reflections across devices.
  • Advanced Search Filters: Add filters for searching within specific date ranges of revelation or Meccan/Medinan Surahs.
  • Thematic Index: Create a curated index of verses organized by common themes (e.g., patience, gratitude, family).
  • PWA Functionality: Enhance the application to be a fully-featured Progressive Web App (PWA) for offline access.

Contributors

kh3rld

Issues