The Quran App is a JavaFX-based application designed to provide users with easy access to the Holy Book of the Muslim Community that is The Al-Quran. This project aims to offer a simple, user-friendly interface for reading, searching and listening to the Quranic verses.
- Search Functionality: Quickly find specific verses or surahs or English/Arabic keywords.
- User-Friendly Interface: Intuitive design built with JavaFX, Scene Builder and CSS.
- Bookmarking: Easily bookmark specific Ayahs which are important to a user.
- Translation: Transaltion available in two languages i.e Bangla and English
- Audio: Audio for each Ayahs can be played with the help of a standard audio-player.
- Modes: Both Dark modes and Light modes are available.
Before you begin, ensure you have met the following requirements:
- Java Development Kit (JDK) 8 or later
- Maven 3.6.0 or later
- Standard Java IDE (Intelij is preferable)
- Clone the repository in your local system
- Build the project using Maven preferably in Intelij
- Build and Run the application from the IDE you are using
Upon launching the application, you will be presented with the main interface where you will be shown all the Surah Cards. Then you can:
- Navigate through different surahs and ayahs simply clicking on the Surah Cards.
- Search for specific keywords or phrases within the Quran by writing the keywords on the searchbar and clicking search.
- Read the Quranic text in a clean, readable format.
- Listen to Audio for specific Ayahs or whole surah including the basic Audio Player Features like continuing one Ayah/Surah and stop, Volume Controls, play/pause/stop etc.
- Translate to two different languages i.e Bangla and English.
- Bookmark specific Ayahs that you want to see later on.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
To contribute:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/YourFeature) - Commit your Changes (
git commit -m 'Add some YourFeature') - Push to the Branch (
git push origin feature/YourFeature) - Open a Pull Request