Skip to content

MutmainX/StudyRemainderBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Study Reminder Bot Telegram

A simple yet powerful Telegram bot designed to help students avoid distractions and stay on track with their study schedule by sending timely, customizable reminders.


➡️ Access the Bot

You can interact with the live/testing version of this bot on Telegram(I can keep it running even if it gets just thousand active users or if i have expenses to afford it running,otherwise I will no longer maintain it) :

update: I cant financially to keep it deployed online with third party services, so this bot may not work anymore on telegram but you can run it yourself locally with instruction provided here. I will keep updating this and adding new features and fixing bugs


✨ Features

  • Interactive Setup: No need to type complex commands. Set reminders entirely through inline buttons.
  • Flexible Scheduling: Choose specific days of the week for your reminders:
    • Every Day
    • Weekdays (Mon-Fri)
    • Mon-Thu
    • Weekends (Sat & Sun)
    • Individual days (Sat, Sun)
  • Precise Timing: Select the exact hour of the day for the reminder, organized by Morning, Afternoon, Evening, and Night.
  • Customizable Messages: Set your own personal study reminder message via the /settings menu.
  • Easy Management: View and delete your active reminders at any time.
  • Persistent Storage: Powered by a Supabase (PostgreSQL) database, your reminders are safely stored and will never be lost, even if the bot restarts.

🛠️ Technology Stack

  • Language: Python 3
  • Telegram Library: python-telegram-bot
  • Database: Supabase (Free Tier PostgreSQL)
  • Hosting: Locally or host services

🚀 Getting Started

1. Set Up the Bot on Telegram

  1. Start a chat with @BotFather on Telegram.
  2. Use the /newbot command to create a new bot.
  3. Follow the instructions and BotFather will give you a unique API Token. Save this token.

2. Set Up the Supabase Database

  1. Go to Supabase.com and create a new project.
  2. Go to the SQL Editor and run the SQL query found in the supabase_table.txt file of this repository to create the reminders table.
  3. Go to Project Settings > API. Find and save your Project URL and your anon public API Key.

3. Local Setup & Running

  1. Clone the repository or download zip file:

    git clone https://github.com/MutmainX/StudyRemainderBot.git
    cd StudyRemainderBot
  2. Install the required libraries from requirements.txt:

    pip install -r requirements.txt
  3. Edit out the "for local deploy" comments while remove render deploy lines

  4. Replace with keys : SUPABASE_URL = "replace with your SUPABASE_URL"
    SUPABASE_KEY = "Add your supabase url here" TELEGRAM_TOKEN = "replace with your TELEGRAM_TOKEN"

  5. Run the bot locally:

    python bot.py
  6. Set Remainders. Once set, you will keep getting remainders even after you close local server


☁️ You can deploy it online through various platforms like Render

About

Sends you remainders to Study when you wasting your time

Topics

Resources

License

Stars

Watchers

Forks

Languages