Skip to content

Latest commit

 

History

History
69 lines (59 loc) · 5.05 KB

README.md

File metadata and controls

69 lines (59 loc) · 5.05 KB
Raw

Qur'An Discord Bot

a multipurpose Qur'An Discord bot that allows Muslims to extract verses, translations, audios, and tafsirs instantly. Qur'An bot will soon support Hadith data for users to extract, In Sha Allah.

Disclaimer

This repository has no affiliation with, authorisation from, maintenance by, sponsorship from, or endorsement by Qur'An.com (https://quran.com), Sunnah.com (https://sunnah.com) or any of its affiliates or subsidiaries.

Purpose

In the name of Allah, the Most Merciful, the Most Compassionate, the King of all creation. All praise is due to Allah; we praise Him; seek His help and forgiveness; we seek refuge in Allah from the evils of ourselves and the evils of our actions. For whoever Allah guides none can misguide and whoever He misguides none can guide; I bear witness that there is no true God but Allah alone with no partners and I bear witness that Muhammad ﷺ is His slave and Messenger. May Allah's peace and blessings be upon Muhammad ﷺ, his family, his companions and those who follow them until the Day of Judgement.

After noticing many Islamic Discord servers, I decided to create a Discord bot for the Muslim community to extract almost anything from the Qur'An, such as but not limited to:

  • Tafsirs & Verse-specific translations
  • Audios of Qur'An recitations
  • Juz numbers
  • The verses only revealed in Madīnah
  • The verses only revealed in Mecca
  • Hadith search
  • more

The purpose of this project is to provide the Muslim Ummah with an easily accessible Qur'An in their Discord server(s) for whatever (good) reasons. My plan is to combine all Islamic tools (AIs, websites, audios, media, etc.) into one multi-purpose Discord bot.

Contributions

I welcome contributions from the community and appreciate the time and effort put into making this project better. To contribute, please follow the guidelines and steps outlined below:

Fork the Repository

Start by forking this repository. You can do this by clicking on the "Fork" button located at the top right corner of the GitHub page. This will create a personal copy of the repository under your own GitHub account.

Clone the Repository

Next, clone the forked repository to your local machine using the following command:

$ git clone https://github.com/yourusername/quran-bot.git

Navigate to the cloned directory:

$ cd quran-bot

Create a New Branch

Before making any changes, it's recommended to create a new branch. This ensures that your changes won't interfere with other contributions and keeps the main branch clean. Use the following command to create and switch to a new branch:

$ git checkout -b branch-name

Make the Desired Changes

Now, you can proceed to make your desired changes to the project. Whether it's fixing bugs, adding new features, improving documentation, or optimizing code, your efforts will be instrumental in enhancing the project.

Commit and Push Changes

Once you have made the necessary changes, commit your work using the following commands:

$ git add .
$ git commit -m "Your commit message"

Push the changes to your forked repository:

$ git push origin branch-name

Submit a Pull Request

Head over to the original repository on GitHub and go to the "Pull requests" tab.

  1. Click on the "New pull request" button.
  2. Select your forked repository and the branch containing your changes.
  3. Provide a clear and informative title for your pull request, and use the description box to explain the modifications you have made.
  4. Finally, click on the "Create pull request" button to submit your changes.

Join the Discord

Once you have submitted a pull request, I will review your changes and may provide feedback or request further adjustments. Join the Discord and create a ticket specifying your pull request title and GitHub username. Promptly address any concerns, and collaborate with me (and others) to ensure the smooth progress of your contributions.

Your dedication and contributions are deeply appreciated, and I make Du'aa that your efforts bring great blessings to you. Together, let's make this project a remarkable success, Ameen.