Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.12 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.12 KB
Raw

CAPT Laundry Bot

Laundry bot for the management of laundry timers in CAPT

Setup

Requirements

  • Python 3.12
  • Docker (Only for deployment)

Telegram Bot Setup (Local)

  1. Create your own Telegram bot by following BotFather instructions
  2. Copy the API_KEY (keep this key secret)

Running the Bot

  1. Copy this repository
git clone https://github.com/jloh02/capt-laundry-bot
  1. Create a .env file in root folder with the following content and update Telegram bot API key
TELEGRAM_BOT_API_KEY=<YOUR_API_KEY>
TIMER_DURATION_MINUTES=<TIMER_DURATION_DEFAULTS_TO_34>
CONVO_TIMEOUT_SECONDS=<CONVERSATION_HANDLER_TIMEOUT_DEFAULTS_TO_300>
  1. Install Packages
pip install -r requirements.txt
  1. Run Bot
python src/main.py

Testing Deployment Configurations

Ensure you have docker installed

docker compose build
docker compose up -d

Design Considerations

Instead of a DB, we opted for a local JSON file to allow for ease of deployment and logetivity of the project as this project will be managed at an individual basis outside of the management of CAPT