MySurah - Surah Player

MySurah is a mobile app built with the Ionic framework based on Angular that allows users to listen to and recite Surahs from the Holy Quran. It provides a user-friendly interface for accessing and playing Surahs on mobile devices.

Features

Access and listen to a collection of Surahs from the Holy Quran.
Play, pause, and navigate between different Surahs automatically.
Display the name and reciter of each Surah.
Simple and intuitive user interface for easy navigation and usage.

Prerequisites

Node.js: Make sure you have Node.js installed. You can download it from https://nodejs.org.
Android Studio: Make sure you have Android Studio installed and downloaded all the necessary SDK for android development. You can download it from https://developer.android.com/studio
To develop iOS applications, you need to have a MacOS operating system installed on your computer and Xcode, which is the integrated development environment (IDE) used for iOS development, installed on your MacOS.

Installation and Setup

Clone the repository or download the source code:

git clone https://github.com/aimaniskndar/MySurah.git

Navigate to the project directory:
```
cd MySurah
```
Install the dependencies:

Note: A folder named node_module will be generated.
```
npm install
```
Build the app:
```
ionic build
```
Run the app on a connected Android device or emulator:
```
ionic capacitor run android
```
This will open the app in Android Studio, where you can build and run it on a connected Android device or emulator.

Note: Make sure you have Android Studio installed and configured with the necessary SDKs. Refer to the Android Studio documentation for more information on setting up Android development environment.
Run the app on a connected iOS device or simulator:
```
ionic capacitor run ios
```
This will open the app in Xcode, where you can build and run it on a connected iOS device or simulator.

Note: For iOS development, it is required to have a MacOS with Xcode installed. Ensure that you have Xcode installed and configured on your MacOS. You can download Xcode from the Mac App Store.

Note: Capacitor provides a bridge between your Ionic app and the native platform (Android or iOS). During the first run, Capacitor will copy the necessary files and dependencies to the native project folders (android and ios) so that you can work with the app using the respective platform-specific tools (Android Studio and Xcode).

Alternatively, you can use the Ionic Lab for a browser-based development and testing environment:
```
ionic serve
```
Ionic Lab allows you to preview and test your app in a browser, with live reloading for easy development.

For more information on how to run and test Ionic apps, refer to the official Ionic Documentation.

Audio Source

The Quranic audio used in this app is sourced from Muslim Central. To use the audio in the app, you

need to download the Surah audio files from the Muslim Central website. Follow these steps:

Visit Muslim Central and navigate to the Surah audio section.
Download the Surah audio files in MP3 format.
Create a folder named sounds inside the src/assets directory of your Ionic project.
Copy the downloaded Surah audio files into the src/assets/sounds directory.

Note: The Surah audio files are not included in the Git repository due to their large file size. Make sure to download the audio files separately and add them to the correct location in your project.

Please ensure compliance with the terms and conditions of Muslim Central when using the audio in your own projects.

License

The MySurah app is open source and released under the MIT License. You are free to modify and distribute the app as per the terms of the license.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request. Please follow the guidelines outlined in the Contributing Guidelines.

Acknowledgments

All Quranic audio used in this app are sourced from Muslim Central. Please ensure compliance with the terms and conditions of the source when using the content in your own projects.

Support

If you have any questions or need assistance with the app, please reach out to us at contact.aiman.azman@gmail.com.

Thank you for using MySurah! We hope you find it helpful in reciting and learning from the Holy Quran. May your journey with the Quran be blessed.

For more information about the Ionic framework, visit https://ionicframework.com.

aimaniskndar / MySurah-Ionic-App