# 🎯 Deployment Checklist

Use this checklist to ensure a smooth deployment to Hugging Face Spaces.

## ☐ Pre-Deployment

- [ ] Have a HuggingFace account (create at https://huggingface.co/join)
- [ ] Git is installed on your machine
- [ ] All files in `huggingface_deployment` folder are present:
  - [ ] `app/` folder with all subfolders
  - [ ] `main.py`
  - [ ] `Dockerfile`
  - [ ] `requirements.txt`
  - [ ] `README.md` (with YAML frontmatter)
  - [ ] `.dockerignore`
  - [ ] `.gitignore`
  - [ ] `LICENSE`

## ☐ Create Space

- [ ] Go to https://huggingface.co/new-space
- [ ] Choose a name for your Space
- [ ] Select **Docker** as SDK
- [ ] Choose license: **MIT**
- [ ] Select visibility: Public or Private
- [ ] Click "Create Space"

## ☐ Upload Files

### Option A: Web UI (Drag & Drop)
- [ ] Open your new Space page
- [ ] Click "Files" tab
- [ ] Drag and drop ALL files from `huggingface_deployment` folder
- [ ] Wait for upload to complete

### Option B: Git (Recommended)
- [ ] Clone your Space: `git clone https://huggingface.co/spaces/USERNAME/SPACENAME`
- [ ] Copy all files from `huggingface_deployment` to cloned folder
- [ ] `git add .`
- [ ] `git commit -m "Initial deployment"`
- [ ] `git push`

## ☐ Monitor Build

- [ ] Go to your Space page
- [ ] Click "Logs" tab
- [ ] Watch the build progress
- [ ] Wait for "Running" status (~5-10 minutes)
- [ ] Check for any error messages

## ☐ Test Deployment

- [ ] Note your Space URL: `https://USERNAME-SPACENAME.hf.space`
- [ ] Test health endpoint:
  ```bash
  curl https://USERNAME-SPACENAME.hf.space/
  ```
- [ ] Expected response: `{"status":"ok"}`
- [ ] Test with a simple upload (use Postman, curl, or your frontend)

## ☐ Configure (Optional)

### Hardware Upgrade
- [ ] Go to Space Settings
- [ ] Click "Change hardware"
- [ ] Select desired tier (T4 GPU recommended for production)
- [ ] Confirm upgrade

### Persistent Storage
- [ ] Go to Space Settings
- [ ] Click "Upgrade storage"
- [ ] Select storage tier (Small = $5/month for 20GB)
- [ ] Confirm upgrade

### Environment Variables
- [ ] Go to Space Settings
- [ ] Add any required secrets/variables
- [ ] Save changes

## ☐ Connect Frontend

- [ ] Update frontend API URL to: `https://USERNAME-SPACENAME.hf.space`
- [ ] Test end-to-end flow:
  - [ ] Upload images
  - [ ] Start processing
  - [ ] Check progress
  - [ ] Download results

## ☐ Final Checks

- [ ] Space is publicly accessible (if intended)
- [ ] API responds to all endpoints
- [ ] Image upload works
- [ ] Processing completes successfully
- [ ] Download returns ZIP file
- [ ] Cleanup happens after download

## ☐ Documentation

- [ ] Update your frontend repo with new API URL
- [ ] Share your Space link with users
- [ ] Add Space badge to your GitHub README (optional):
  ```markdown
  [![Open in Spaces](https://huggingface.co/datasets/huggingface/badges/raw/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/USERNAME/SPACENAME)
  ```

## ☐ Monitoring

- [ ] Check Space analytics (views, usage)
- [ ] Monitor logs for errors
- [ ] Watch resource usage in Settings
- [ ] Set up billing alerts (if using paid tier)

---

## 🎉 Deployment Complete!

Once all items are checked, your Image Selector Backend is live on HuggingFace Spaces!

**Your API**: `https://USERNAME-SPACENAME.hf.space`

**Your Space**: `https://huggingface.co/spaces/USERNAME/SPACENAME`

---

## 📞 Need Help?

- Check `DEPLOYMENT_GUIDE.md` for detailed instructions
- Check `QUICK_START.md` for overview
- HF Community: https://huggingface.co/spaces
- HF Discord: https://discord.gg/hugging-face