Al Quran Telegram Bot

For the Ummah, By the Ummah

The Al Quran Telegram Bot is an open-source project that enables users to retrieve Arabic or English text, Tafsir and audio of each verse from the Quran. The bot can be easily integrated into Telegram, allowing users to access the verses from anywhere at any time.

To see the Changes and Modifications, see ChangeLogs.md

To see what is to be done next, see TODO.md

How to Use

To use the Al Quran Telegram Bot, you must first have a Telegram account. Once you have an account, follow these steps:

1. Search for @AlFurqanRobot in the Telegram app.
2. Click on the bot and click "Start" to initiate the conversation.
3. Type in the number of the Surah you want to read or listen to. For example, to read Surah Al-Fatiha, type "1". To listen to Surah Al-Fatiha, type "/audio 1".
4. Type any surah name to start reading that surah. Ex: Fatiha, nas
5. You can also search for specific verses by typing in the Surah number and the verse number. For example, to read or listen to Verse 7 of Surah Al-Fatiha, type "1:7" or "/audio 1:7". ( to be added )

How to Contribute

Contributions to the Al Quran Telegram Bot are welcome and appreciated. Contribution to this will be very helpful for the whole Muslim Ummah. The Al Quran Telegram Bot is built using python-telegram-bot library that uses the Telegram Bot API. If you are a developer and want to contribute to the project, follow these steps:

1. Fork the repository.
2. Clone the repository to your local machine.
3. Install the dependencies by running pip install -r requirements.txt.
4. Create a new bot on Telegram from @Botfather and obtain an API token.
5. Create a .env file and add your API token as TOKEN=your_token_here.
6. Run the bot locally by running python main.py.
7. Make changes to the code and create a pull request with your changes.

License

The Al Quran Telegram Bot is open-source software licensed under the MIT license. See the LICENSE file for more information.