Add kiosk-api with HF deployment

.dockerignore

@@ -0,0 +1,10 @@
+.env
+.env.*
+*.pyc
+__pycache__
+.venv
+venv
+.git
+.gitignore
+*.md
+!README.md

.github/workflows/sync-to-hf.yml

@@ -0,0 +1,28 @@
+# Push to Hugging Face Space on every push to main.
+# Create the Space first: huggingface.co/spaces → New Space → Docker → Blank.
+# Name it e.g. monish563/NU-Kiosk-API
+#
+# GitHub repo: Settings → Secrets and variables → Actions → Add HF_TOKEN
+
+name: Sync to Hugging Face
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      - name: Push to Hugging Face Space
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: |
+          git push https://monish563:$HF_TOKEN@huggingface.co/spaces/monish563/NU-Kiosk-API main --force

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.11-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PORT=7860
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY backend backend
+COPY Archive Archive
+
+EXPOSE 7860
+
+# HF Spaces set PORT=7860; use PORT or fallback to 7860
+CMD ["sh", "-c", "uvicorn backend.main:app --host 0.0.0.0 --port ${PORT:-7860}"]

README.md

@@ -1,3 +1,14 @@
+---
+title: Northwestern CS Kiosk API
+emoji: 🎙️
+colorFrom: blue
+colorTo: indigo
+sdk: docker
+sdk_version: "latest"
+app_file: Dockerfile
+pinned: false
+---
+
 # Northwestern CS Kiosk API
 
 REST API backend for the Northwestern CS Department Kiosk. This is a stripped-down version optimized for integration with external systems (e.g., speech-to-text/text-to-speech).
@@ -27,6 +38,53 @@ The API will be available at `http://0.0.0.0:8000`
 
 ---
 
+## Deploy to Hugging Face Spaces
+
+Deploy this API as a public endpoint so your manager (or STT/TTS systems) can send requests from anywhere.
+
+### 1. Create a new Space
+
+1. Go to [huggingface.co/spaces](https://huggingface.co/spaces)
+2. Click **Create new Space**
+3. Choose **Docker** SDK, **Blank** template
+4. Name it (e.g. `monish563/NU-Kiosk-API`)
+5. Create, then push this `kiosk-api` folder to the Space repo
+
+### 2. Add secrets (Settings → Variables and secrets → Secrets Private)
+
+| Secret | Required | Description |
+|--------|----------|-------------|
+| `ANTHROPIC_API_KEY` | **Yes*** | Anthropic API key (starts with `sk-ant-api03-...`) |
+| `KIOSK_LLM_PROVIDER` | No | Default: `anthropic` |
+| `KIOSK_LLM_MODEL` | No | Default: `claude-3-5-haiku-20241022` |
+| `KIOSK_LLM_SYSTEM_PROMPT` | No | Custom system prompt for the receptionist |
+| `KIOSK_LLM_STYLE` | No | Style guidelines for TTS-friendly responses |
+| `OPENAI_API_KEY` | No | If using `provider: "openai"` |
+| `GEMINI_API_KEY` | No | If using `provider: "gemini"` |
+
+*At least one LLM API key (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, or `GEMINI_API_KEY`) is required.
+
+### 3. Endpoint URL for your manager
+
+Once the Space is built and running, the base URL will be:
+
+```
+https://<your-username>-<space-name>.hf.space
+```
+
+**Main endpoint (for STT → TTS flow):**
+
+```
+POST https://<your-username>-<space-name>.hf.space/api/query
+Content-Type: application/json
+
+{"question": "Where is Professor Hammond's office?"}
+```
+
+**Response:** `{"answer": "...", ...}` — send `answer` to your TTS system.
+
+---
+
 ## API Reference
 
 ### Health Check