mattia/birthdaybot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Emojified readme

Browse Source
This commit is contained in:
Mattia Mascarello 2024-05-16 11:44:17 +02:00 committed by GitHub
parent 133f789c64
commit d8aaacf868
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,42 +1,42 @@
# Birthday Reminder Bot # Birthday Reminder Bot 🎂
A simple telegram bot that reminds you of your friends' birthdays. A simple telegram bot 🤖 that reminds you of your friends' birthdays 🥳.
- Birthday list (current age, time to birthday, sorted) - Birthday list (current age ⏲️, time to birthday 🔜, sorted 🥇)
- Monthly, weekly, daily reminders - Monthly 📆, weekly 📆, daily 📆 reminders
> I made this bot for my personal use, but you can use it too. Just follow the instructions below. > I made this bot for my personal use, but you can use it too. Just follow the instructions below.
## Installation ## Installation :
1. Clone the repository 1. Clone the repository
```bash ```bash
git clone git@github.com:MatMasIt/birthdaybot.git git clone git@github.com:MatMasIt/birthdaybot.git
``` ```
2. Create a virtual environment 2. Create a virtual environment 🏗️
```bash ```bash
python3 -m venv venv python3 -m venv venv
``` ```
3. Activate the virtual environment 3. Activate the virtual environment 🔦
```bash ```bash
source venv/bin/activate source venv/bin/activate
``` ```
4. Install the requirements 4. Install the requirements 📥
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
5. Create a `.env` file in the root directory and add the following variables 5. Create a `.env` file in the root directory and add the following variables (you can obtain the token at [@botfather](https://t.me/botfather))
```bash ```bash
TOKEN=YOUR_TELEGRAM_BOT_TOKEN TOKEN=YOUR_TELEGRAM_BOT_TOKEN
``` ```
6. Run the bot 6. Run the bot ⏯️
```bash ```bash
python bot.py python bot.py
``` ```