Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.31 KB

README.md

File metadata and controls

26 lines (18 loc) · 1.31 KB
Raw

SSA_telebot

This is the Telegram Bot for SSA@UCLA! We use the python-telegram-bot framework for our development.

Developer Notes

  • Bot name: SSA Ah Gong

  • Bot username: uclassa_telebot

  • Image from Ah Kong Durian - Please check for copyright conflicts!

Environment Variables

Check the config.env.template file for the required environment variables. You can leave TIMEZONE blank. Use any api key you want, but just make sure it matches the one you use on your local django server. Refer to telegram's documentation on how to get a TOKEN.

Running Locally

Refer to the charkwayteow repository's README for steps to set up a python virtual environment. Install the required dependencies and run src/main.py to run the bot.

pip3 install -r requirements.txt
python3 src/main.py

Most of the functionality of the bot is closely tied with the backend server. Follow the instructions in the charkwayteow repository to run it locally.

Workplan

See notion page for more details.