banner

A complex multi-service system providing a Discord bot and browser-based interface to UTSA's course data.

Services

The application consists of three modular services that can be run independently or together:

• Discord Bot (bot)

  • Primary interface for course monitoring and data queries
  • Built with Serenity and Poise frameworks for robust command handling
  • Uses slash commands with comprehensive error handling and logging

• Web Server (web)

  • Axum-based server with Vite/React-based frontend
  • Embeds static assets at compile time with E-Tags & Cache-Control headers

• Scraper (scraper)

  • Intelligent data collection system with priority-based queuing inside PostgreSQL via sqlx
  • Rate-limited scraping with burst handling to respect UTSA's systems
  • Handles course data updates, availability changes, and metadata synchronization

Quick Start

bun install --cwd web  # Install frontend dependencies
cargo build  # Build the backend

just dev # Runs auto-reloading dev build
just dev --services bot,web # Runs auto-reloading dev build, running only the bot and web services
just dev-build # Development build with release characteristics (frontend is embedded, non-auto-reloading)

just build # Production build that embeds assets

Documentation

Comprehensive documentation is available in the docs/ folder.