Al Quran Website

بِسْمِ اللَّهِ الرَّحْمَٰنِ الرَّحِيمِ
In the Name of Allah, the Most Gracious, the Most Merciful

Tip

• Visit the Al Quran Website: alquran.cc
• Alternative Domain: readthequran.vercel.app

A modern web interface for exploring the Al Quran, designed to help believers connect deeply with the divine words of Allah (SWT) and seek His eternal guidance. This project is a humble effort to make the Quran more accessible to people worldwide, InshaAllah.

---

May Allah (SWT) bless every soul and shower His mercy upon us. May our hearts be illuminated by the Quran, guiding us through trials. Grant us strength in faith and fulfill our righteous desires. Let this project inspire others towards righteousness and bring us closer to Allah (SWT). May His guidance lead us to success in this world and the Hereafter. Ameen.

Features

• Verse Search (Ayah): Easily search and access specific verses of the Quran.
• Chapter Browser (Surah): Read full chapters of the Quran in a clean and user-friendly interface.
• Mood-based Recommendations: Receive personalized Quranic verses based on your emotional state.
• Progressive Web App (PWA): Installable and mobile-friendly.
• Multiple Translations: Explore the Quran in various languages and translations.
• Responsive Design: Optimized for all devices, ensuring accessibility for everyone.

Usage

Ayah Search

1. Select a chapter (Surah) from the dropdown.
2. Choose a specific verse (Ayah).
3. Reflect on the verse and its translation.
4. Copy verses to share with others.

Surah Browser

1. Select a complete chapter (Surah).
2. Read through all its verses.
3. Switch between different translations for deeper understanding.

Mood Selection

1. Choose your current emotional state.
2. Receive relevant Quranic verses for comfort and guidance.
3. Supported moods:
   • Happy
   • Grateful
   • Angry
   • Sad
   • Lonely
   • Anxious

---

Quran API

This website utilizes the Quran API which is also built and maintained by me. This API provides easy access to Quranic data such as surah details, ayah text, translations, and more. It is free and public for everyone to use.

You can explore the full API here: Quran API Repository.

For more information and documentation on how to integrate or use the API, please visit the repository or raise any questions or issues you may have there.

May Allah (SWT) make it beneficial for all.

---

Contributing

We welcome contributions from the Ummah to improve this project. The project is Dockerized for easy setup and contribution.

Docker Setup

1. Ensure Docker is installed on your system.
2. Clone the repository:

   git clone https://github.com/ktauchathuranga/quran-frontend.git
   cd quran-frontend

3. Build the Docker image:

   docker-compose build

4. Start the container:

   docker-compose up

5. Access the application at http://localhost.

Contribution Steps

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/your-feature).
3. Commit changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/your-feature).
5. Open a Pull Request.

Report issues or suggest features through our issue tracker.

"And cooperate in righteousness and piety, but do not cooperate in sin and aggression." (Quran 5:2)

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Contact

Ashen Chathuranga
Sponsor Project

---

May Allah (SWT) accept this effort, forgive our shortcomings, and make this project a means of guidance for all. Ameen.