Skip to content

DoozyDoz/Yasarna

Repository files navigation

Yasarna Quran Reader App

The Yasarna Quran Reader app is an open-source Android application that aims to help users learn how to read the Quran using the book "Yasarna." The app provides a user-friendly interface that allows users to tap on words or sentences within the book's pages and hear the pronunciation of the selected content.

Features

  • Tap-to-pronounce: Users can tap on any word or sentence in the pages of the "Yasarna" book, and the app will play the corresponding audio pronunciation.

  • User-submitted audios: The app allows users to upload their versions of audio pronunciations. Once uploaded, the submissions will be reviewed and approved by the app's maintainers.

  • Community-driven audio selection: Approved user-submitted audios will become available as choices for users to select from in the app. This way, the app's audio library will grow with valuable contributions from the community.

  • Rating system: Users can rate the audios they listen to, helping others identify the most accurate and high-quality pronunciations.

  • Page navigation: The app will display all 66 pages of the "Yasarna" book, allowing users to navigate through the content easily.

Getting Started

Prerequisites

Before building and running the app, make sure you have the following tools installed on your development environment:

Installation

  1. Clone this repository to your local machine using the following command:

git clone https://github.com/DoozyDoz/Yasarna.git

  1. Open Android Studio and select "Open an existing Android Studio project."

  2. Navigate to the cloned repository and select the project folder.

  3. Build the project in Android Studio and run it on an Android emulator or a physical device.

Contributing

We welcome contributions to the Yasarna Quran Reader app! If you'd like to contribute, follow these steps:

  1. Fork this repository to your GitHub account.

  2. Create a new branch from the main branch for your changes.

  3. Make your desired changes, following the project's coding guidelines.

  4. Submit a pull request, explaining the changes you've made and the reason for them.

  5. Your pull request will be reviewed by the project maintainers, and if approved, it will be merged into the main repository.

License

This project is open-source and available under the MIT License.

Contact

If you have any questions, suggestions, or feedback, you can reach out to the project maintainers via email at contact@yasarnaquranreader.com or open an issue in the GitHub repository.

We hope this app helps users in their journey to learn how to read the Quran with the help of the "Yasarna" book. Happy learning and contributing!

About

learn how to read the Quran

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages