READ FIRST

This project has reached EOL, which means that no new features will be developed. We're only merging bug fixes and/or security pull requests.

ReminderBot - Telegram Prayer Time Reminder Bot

ReminderBot is a versatile Telegram bot designed to remind people of prayer times, offering an array of features to enhance the user experience. It supports multiple languages, configurable notifications, feedback collection, regional prayer time searches, daily prayer time reminders, customizable fasting reminders, regional reminders, statistics tracking, and more. This bot is built using Node.js and relies on the Telegram Bot API for communication.

Key Features

• Multi-language support for a global user base.
• Configurable prayer time notifications and reminders.
• User feedback collection to improve the bot's functionality.
• Regional search for prayer times by user location.
• Daily prayer time reminders for personalized alerts.
• Configurable fasting reminders to accommodate different fasting schedules.
• Regional reminders to provide location-specific information.
• Statistics tracking to monitor bot usage and engagement.

Installation

Ensure you have pnpm installed. You can install it globally using npm:

npm install -g pnpm

Clone the repository to your local machine:

git clone https://github.com/Xayrulloh/ReminderBot.git

Navigate to the project directory:

cd ReminderBot

Install the project dependencies using pnpm:

pnpm install

Configuration

To use ReminderBot, you need to set up a Telegram Bot and obtain the API token. Follow these steps:

1. Create a Telegram Bot using BotFather.
2. Copy the API token provided by BotFather.
3. Create a .env file in the project directory with the following content:

TOKEN=YOUR_BOT_API_TOKEN

Replace TOKEN with the actual API token you obtained from BotFather.

Usage

To start the bot in development mode:

pnpm run start:dev

To build and start the bot in production mode:

pnpm run build
pnpm start

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

---

Note: Always keep your API token and sensitive information secure. Do not share them in your public repositories or expose them to unauthorized users.

Feel free to contribute, report issues, or suggest improvements by creating pull requests or opening issues.