ai-tutor-chatbot / README.md
omarsol's picture
update readme - adding course instructions
ad01081
metadata
title: AI Tutor Chatbot
emoji: πŸ§‘πŸ»β€πŸ«
colorFrom: gray
colorTo: pink
sdk: docker
app_port: 7860
pinned: false

Gradio UI Chatbot

A Gradio UI for the chatbot is available in scripts/main.py.

The Gradio demo is deployed on Hugging Face Spaces at: AI Tutor Chatbot on Hugging Face.

Note: A GitHub Action automatically deploys the Gradio demo when changes are pushed to the main branch (excluding documentation and scripts in the data/scraping_scripts directory).

Gradio UI β€” Quick Start

  1. Install dependencies (requires uv):

    uv sync
    
  2. Configure environment variables:

    cp .env.example .env  # then edit values
    
  3. Run:

    uv run -m scripts.main
    

    Starts the Gradio AI Tutor interface.

Updating Data Sources

For adding new courses or updating documentation: