Skip to content

README.md

Latest commit

 

History

History
75 lines (48 loc) · 1.43 KB

README.md

File metadata and controls

75 lines (48 loc) · 1.43 KB
Raw
title CommunitySuperBuild
sdk gradio
app_file app.py

CommunitySuperBuild

Community build for the SuperDataScience AI Engineering Challenge course.

Live app: https://huggingface.co/spaces/ai-challenge/communitysuperbuild

Deployment

Merging to main auto-deploys to the Hugging Face Space via GitHub Actions (.github/workflows/publish.yml).

Local dev

Prerequisites

  • Python 3.10+

Setup

  1. Create a virtual environment

    python -m venv venv

  2. Activate it

    Git Bash / macOS / Linux:

    source venv/Scripts/activate   # Windows (Git Bash)
source venv/bin/activate       # macOS / Linux

    PowerShell:

    .\venv\Scripts\Activate.ps1

  3. Install dependencies

    pip install -r requirements.txt

  4. Configure environment variables (optional, for local secrets)

    cp .env.example .env

    Edit .env and add your API keys.

  5. Run the app

    python app.py

    Gradio will print a local URL (usually http://127.0.0.1:7860).

Contributing

  1. Create a branch from main
  2. Make your changes and test locally
  3. Open a PR against main with a short summary of what is added
  4. After review and approvals - merge the branch and test your changes once deployed

Please don't push directly to main. Keep PRs focused and don't commit secrets. Only add examples in env.example