Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mhewedy committed May 23, 2024
1 parent 843f387 commit dcc3c6b
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ A simple Telegram chatbot to suggest who will order the lunch today!

## Deployment

1. Create bot using telegram [@botfather](https://telegram.me/BotFather)
see [How to get Telegram Bot Chat ID](https://gist.github.com/nafiesl/4ad622f344cd1dc3bb1ecbe468ff9f8a)
2. Create a telegram group, add the bot to the group, and make it admin
3. You need to set the env var `BOT_TOKEN` and `CHAT_ID`. (you get from previous steps, where `CHAT_ID` should refer to the group created in prev step)
4. Run the app using `python main.py`.
5. Start sending commands in the group (e.g. `/help`), the bot will detect food names as well (using chatgpt)
6. Enjoy!

> This app uses [telebot](https://github.com/mhewedy/telebot)
1. Create bot using telegram [@BotFather](https://telegram.me/BotFather)
see [How to get Telegram Bot Chat ID](https://gist.github.com/nafiesl/4ad622f344cd1dc3bb1ecbe468ff9f8a).
2. Create a telegram group, add the bot to the group, and make it admin.
3. Set the env var `BOT_TOKEN` and `CHAT_ID`. (you get from previous steps, where `CHAT_ID` should refer to
the group created in prev step).
4. Optionally, if you need to persist the data between restarts, configure `VOLUME_ROOT_FS` to point to path of some
persistent volume (block or network storage)
5. Run the app using `python main.py`.
6. Start sending commands in the group (e.g. `/help`), the bot will detect food names as well (using chatgpt)
7. Enjoy!

> This app built using [telebot](https://github.com/mhewedy/telebot)

0 comments on commit dcc3c6b

Please sign in to comment.