Firdaws - فردوس

A Comprehensive Islamic Platform for Quran, Sunnah, and Beyond

---

Firdaws is a professional, open-source web application designed to serve the global Muslim community. It provides a seamless experience for reading and listening to the Noble Quran, exploring the Sunnah, and accessing a wealth of Islamic knowledge.

✨ Live Demo | 📖 Wiki | 🤝 Contribute

🌟 Key Features

• 📖 Noble Quran: Read the full Quran with Uthmani script, translations, and tafsir.
• 🎧 Audio Library: Listen to over 100 world-renowned reciters in high quality.
• 📜 Sunnah & Hadith: Browse the Six Books of Hadith (Kutub al-Sittah) with detailed explanations.
• 📚 Islamic Library: Access classical and modern books on Aqeedah, Fiqh, and Seerah.
• 🎙️ Scholar Lectures: Thousands of lectures and lessons from senior scholars.
• 📻 24/7 Live Radio: Continuous broadcasts of Quranic recitations and religious programs.
• 💬 Community Forum: A space for questions, answers, and knowledge sharing.

📸 UI Previews

Home Page: Access all features from a beautiful, intuitive dashboard.

Quran Section: Immersive reading and listening experience with Uthmani script.

🚀 How to Use Like a Pro

🔍 1. Master the Unified Search

Don't waste time clicking through menus. Use the global search bar to find specific Ayahs, Hadiths, or Scholar names instantly across the entire platform. It supports both Arabic and English queries.

🎵 2. Leverage the Global Audio Player

Experience uninterrupted spirituality. Start a recitation or a lecture and continue browsing other sections. The persistent audio player allows you to listen while you read or learn in other parts of the app.

⚙️ 3. Personalize Your View

Click on the settings icon to customize your experience. You can switch between light and dark modes, adjust font sizes for comfortable reading, and choose your preferred reciter for the global player.

🎓 4. Follow Your Favorite Scholars

Deep dive into Islamic sciences by following specific teachers in the "Scholars" section. You'll find organized series and complete lecture libraries, making it easy to track your progress in a course.

🛠️ Environment Setup

Before running the application, you need to set up your environment variables:

1. Server Environment

• Navigate to the server directory.
• Copy .env.example to a new file named .env.
• Fill in your MongoDB URI, Gemini API Key, and ImageKit credentials.

2. Client Environment

• Navigate to the client directory.
• Copy .env.example to a new file named .env.
• Fill in your Clerk Publishable Key and ImageKit Public Key.

🛠️ Tech Stack

• Frontend: React.js, Vite, Tailwind CSS (Lucide Icons)
• Backend: Node.js, Express
• Database: MongoDB
• Containerization: Docker & Docker Compose
• State Management: Context API

💻 Local Development

1. Clone the repository:

   git clone https://github.com/Mohamedkrms/firdws.git
   cd firdws

2. Run with Docker:

   docker-compose up --build

3. Access the app: Open your browser and navigate to http://localhost:5173.

🤝 Contributing

We welcome contributions from developers, designers, and content creators. Whether it's fixing a bug, adding a new feature, or improving translations, your help is appreciated!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📜 License

Distributed under the MIT License. See LICENSE for more information.

---

May Allah reward everyone who contributes to or uses this project. 🤲

Built with ❤️ by KarmsDev