Omar Kamel commited on
Commit Β·
ef16637
1
Parent(s): afa4b38
Add final deployment checklist
Browse files- PUSH_TO_HF_CHECKLIST.md +292 -0
PUSH_TO_HF_CHECKLIST.md
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Push to Hugging Face - Final Checklist β
|
| 2 |
+
|
| 3 |
+
## π Pre-Deployment Checklist
|
| 4 |
+
|
| 5 |
+
### β
Repository Ready
|
| 6 |
+
- [x] 39 essential files committed
|
| 7 |
+
- [x] No sensitive data (.env excluded)
|
| 8 |
+
- [x] No test files included
|
| 9 |
+
- [x] No legacy/unused code
|
| 10 |
+
- [x] Documentation complete
|
| 11 |
+
- [x] Deployment scripts ready
|
| 12 |
+
|
| 13 |
+
### β
Code Quality
|
| 14 |
+
- [x] Production logging added
|
| 15 |
+
- [x] Error handling sanitized
|
| 16 |
+
- [x] Rate limiting configured
|
| 17 |
+
- [x] Authentication hardened
|
| 18 |
+
- [x] CORS configured for production
|
| 19 |
+
- [x] Health check endpoint added
|
| 20 |
+
|
| 21 |
+
### π¦ Files Included (39 total)
|
| 22 |
+
|
| 23 |
+
**Core Application:**
|
| 24 |
+
- app.py (Hugging Face entry point)
|
| 25 |
+
- main.py (FastAPI app)
|
| 26 |
+
- requirements.txt
|
| 27 |
+
- Dockerfile
|
| 28 |
+
- docker-compose.yml
|
| 29 |
+
|
| 30 |
+
**Source Code (27 files):**
|
| 31 |
+
- src/boss_agent_v2.py (main agent)
|
| 32 |
+
- src/api/routes_agent_v2.py (V2 routes)
|
| 33 |
+
- All tools, utils, and API routes
|
| 34 |
+
|
| 35 |
+
**Documentation (7 files):**
|
| 36 |
+
- README.md
|
| 37 |
+
- AGENT_V2_QUICKSTART.md
|
| 38 |
+
- AGENT_V2_ARCHITECTURE.md
|
| 39 |
+
- AGENT_V2_DOCUMENTATION.md
|
| 40 |
+
- HUGGINGFACE_DEPLOYMENT.md
|
| 41 |
+
- DEPLOYMENT_SUMMARY.md
|
| 42 |
+
- PUSH_TO_HF_CHECKLIST.md (this file)
|
| 43 |
+
|
| 44 |
+
**Deployment:**
|
| 45 |
+
- deploy_to_hf.sh (Linux/Mac)
|
| 46 |
+
- deploy_to_hf.bat (Windows)
|
| 47 |
+
- .env.production.example
|
| 48 |
+
- .gitignore
|
| 49 |
+
|
| 50 |
+
## π Deployment Steps
|
| 51 |
+
|
| 52 |
+
### Step 1: Login to Hugging Face
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
huggingface-cli login
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
Enter your token from: https://huggingface.co/settings/tokens
|
| 59 |
+
|
| 60 |
+
### Step 2: Create New Space
|
| 61 |
+
|
| 62 |
+
Go to: https://huggingface.co/new-space
|
| 63 |
+
|
| 64 |
+
Settings:
|
| 65 |
+
- **Name**: `boss-food-ordering-agent-v2` (or your choice)
|
| 66 |
+
- **SDK**: Docker
|
| 67 |
+
- **Visibility**: Public or Private
|
| 68 |
+
- Click **Create Space**
|
| 69 |
+
|
| 70 |
+
### Step 3: Deploy Using Script
|
| 71 |
+
|
| 72 |
+
**Windows:**
|
| 73 |
+
```bash
|
| 74 |
+
deploy_to_hf.bat YOUR_USERNAME boss-food-ordering-agent-v2
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
**Linux/Mac:**
|
| 78 |
+
```bash
|
| 79 |
+
chmod +x deploy_to_hf.sh
|
| 80 |
+
./deploy_to_hf.sh YOUR_USERNAME boss-food-ordering-agent-v2
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
**Or manually:**
|
| 84 |
+
```bash
|
| 85 |
+
git remote add hf https://huggingface.co/spaces/YOUR_USERNAME/boss-food-ordering-agent-v2
|
| 86 |
+
git push hf master
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
### Step 4: Configure Environment Variables
|
| 90 |
+
|
| 91 |
+
In your Space settings (https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE/settings):
|
| 92 |
+
|
| 93 |
+
**Required:**
|
| 94 |
+
```
|
| 95 |
+
SUPABASE_URL=https://your-project.supabase.co
|
| 96 |
+
SUPABASE_KEY=your-anon-public-key
|
| 97 |
+
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
**Optional:**
|
| 101 |
+
```
|
| 102 |
+
HUGGINGFACE_API_KEY=hf_your_api_key_here
|
| 103 |
+
ALLOWED_ORIGINS=https://your-flutter-app.com
|
| 104 |
+
SESSION_TIMEOUT_MINUTES=15
|
| 105 |
+
```
|
| 106 |
+
|
| 107 |
+
### Step 5: Wait for Build
|
| 108 |
+
|
| 109 |
+
Monitor the build in the **Logs** tab. Build takes ~5-10 minutes.
|
| 110 |
+
|
| 111 |
+
### Step 6: Test Deployment
|
| 112 |
+
|
| 113 |
+
**Health Check:**
|
| 114 |
+
```bash
|
| 115 |
+
curl https://YOUR_USERNAME-YOUR_SPACE_NAME.hf.space/api/v2/health
|
| 116 |
+
```
|
| 117 |
+
|
| 118 |
+
**Expected Response:**
|
| 119 |
+
```json
|
| 120 |
+
{
|
| 121 |
+
"status": "healthy",
|
| 122 |
+
"version": "2.0.0",
|
| 123 |
+
"service": "Boss Food Ordering Agent V2"
|
| 124 |
+
}
|
| 125 |
+
```
|
| 126 |
+
|
| 127 |
+
**Chat Test (requires JWT):**
|
| 128 |
+
```bash
|
| 129 |
+
curl -X POST https://YOUR_USERNAME-YOUR_SPACE_NAME.hf.space/api/v2/chat \
|
| 130 |
+
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
|
| 131 |
+
-H "Content-Type: application/json" \
|
| 132 |
+
-d '{"message": "show me chicken dishes"}'
|
| 133 |
+
```
|
| 134 |
+
|
| 135 |
+
### Step 7: Update Flutter App
|
| 136 |
+
|
| 137 |
+
Update your Flutter app configuration:
|
| 138 |
+
|
| 139 |
+
```dart
|
| 140 |
+
final String apiBaseUrl = 'https://YOUR_USERNAME-YOUR_SPACE_NAME.hf.space';
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
## π― Quick Command Reference
|
| 144 |
+
|
| 145 |
+
```bash
|
| 146 |
+
# Login
|
| 147 |
+
huggingface-cli login
|
| 148 |
+
|
| 149 |
+
# Check login status
|
| 150 |
+
huggingface-cli whoami
|
| 151 |
+
|
| 152 |
+
# Deploy (Windows)
|
| 153 |
+
deploy_to_hf.bat YOUR_USERNAME YOUR_SPACE_NAME
|
| 154 |
+
|
| 155 |
+
# Deploy (Linux/Mac)
|
| 156 |
+
./deploy_to_hf.sh YOUR_USERNAME YOUR_SPACE_NAME
|
| 157 |
+
|
| 158 |
+
# Manual push
|
| 159 |
+
git remote add hf https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
|
| 160 |
+
git push hf master
|
| 161 |
+
|
| 162 |
+
# Update deployment
|
| 163 |
+
git add .
|
| 164 |
+
git commit -m "Update message"
|
| 165 |
+
git push hf master
|
| 166 |
+
```
|
| 167 |
+
|
| 168 |
+
## π What Gets Deployed
|
| 169 |
+
|
| 170 |
+
### Included β
|
| 171 |
+
- Production-ready agent V2
|
| 172 |
+
- All necessary source code
|
| 173 |
+
- Docker configuration
|
| 174 |
+
- Health check endpoint
|
| 175 |
+
- Rate limiting
|
| 176 |
+
- JWT authentication
|
| 177 |
+
- Session management
|
| 178 |
+
- Semantic search
|
| 179 |
+
- Documentation
|
| 180 |
+
|
| 181 |
+
### Excluded β
|
| 182 |
+
- Test files (test_*.py)
|
| 183 |
+
- Development files (.env)
|
| 184 |
+
- Legacy code (boss-restaurant-chat/)
|
| 185 |
+
- IDE files (.vscode/, .kiro/)
|
| 186 |
+
- Cache files (__pycache__/)
|
| 187 |
+
- Documentation drafts
|
| 188 |
+
- Old markdown files
|
| 189 |
+
|
| 190 |
+
## π Verification Checklist
|
| 191 |
+
|
| 192 |
+
After deployment, verify:
|
| 193 |
+
|
| 194 |
+
- [ ] Health endpoint responds: `/api/v2/health`
|
| 195 |
+
- [ ] Agent info available: `/api/v2/agent/info`
|
| 196 |
+
- [ ] Authentication works (401 without token)
|
| 197 |
+
- [ ] Rate limiting active (429 after 30 req/min)
|
| 198 |
+
- [ ] Chat endpoint works with valid JWT
|
| 199 |
+
- [ ] Search intent works
|
| 200 |
+
- [ ] Cart operations work
|
| 201 |
+
- [ ] Session persistence works (15 min)
|
| 202 |
+
- [ ] Logs show no errors
|
| 203 |
+
- [ ] Flutter app can connect
|
| 204 |
+
|
| 205 |
+
## π Common Issues
|
| 206 |
+
|
| 207 |
+
### "Authentication failed"
|
| 208 |
+
- Check environment variables are set
|
| 209 |
+
- Verify Supabase credentials
|
| 210 |
+
- Ensure JWT token is valid
|
| 211 |
+
|
| 212 |
+
### "Build failed"
|
| 213 |
+
- Check Logs tab for errors
|
| 214 |
+
- Verify requirements.txt
|
| 215 |
+
- Ensure Dockerfile is correct
|
| 216 |
+
|
| 217 |
+
### "Rate limit exceeded"
|
| 218 |
+
- Default: 30 req/min per IP
|
| 219 |
+
- Normal behavior for testing
|
| 220 |
+
- Wait 1 minute or adjust limit
|
| 221 |
+
|
| 222 |
+
### "Database connection failed"
|
| 223 |
+
- Verify SUPABASE_URL
|
| 224 |
+
- Check SUPABASE_KEY
|
| 225 |
+
- Ensure tables exist in Supabase
|
| 226 |
+
|
| 227 |
+
## π Post-Deployment
|
| 228 |
+
|
| 229 |
+
### Monitor
|
| 230 |
+
- Check Logs tab regularly
|
| 231 |
+
- Monitor `/api/v2/health`
|
| 232 |
+
- Track active sessions at `/api/v2/agent/info`
|
| 233 |
+
|
| 234 |
+
### Update
|
| 235 |
+
```bash
|
| 236 |
+
git add .
|
| 237 |
+
git commit -m "Your changes"
|
| 238 |
+
git push hf master
|
| 239 |
+
```
|
| 240 |
+
|
| 241 |
+
### Rollback (if needed)
|
| 242 |
+
```bash
|
| 243 |
+
git revert HEAD
|
| 244 |
+
git push hf master
|
| 245 |
+
```
|
| 246 |
+
|
| 247 |
+
## π Success Indicators
|
| 248 |
+
|
| 249 |
+
You'll know deployment is successful when:
|
| 250 |
+
|
| 251 |
+
1. β
Build completes without errors
|
| 252 |
+
2. β
Health endpoint returns "healthy"
|
| 253 |
+
3. β
Agent info shows correct version (2.0.0)
|
| 254 |
+
4. β
Chat endpoint accepts requests
|
| 255 |
+
5. β
Flutter app can connect and chat
|
| 256 |
+
6. β
Sessions persist for 15 minutes
|
| 257 |
+
7. β
Rate limiting works (429 after 30 req)
|
| 258 |
+
|
| 259 |
+
## π Need Help?
|
| 260 |
+
|
| 261 |
+
- **Hugging Face Docs**: https://huggingface.co/docs/hub/spaces
|
| 262 |
+
- **Deployment Guide**: See HUGGINGFACE_DEPLOYMENT.md
|
| 263 |
+
- **API Docs**: See AGENT_V2_DOCUMENTATION.md
|
| 264 |
+
- **Architecture**: See AGENT_V2_ARCHITECTURE.md
|
| 265 |
+
|
| 266 |
+
---
|
| 267 |
+
|
| 268 |
+
## π Ready to Deploy!
|
| 269 |
+
|
| 270 |
+
Run this command to deploy:
|
| 271 |
+
|
| 272 |
+
**Windows:**
|
| 273 |
+
```bash
|
| 274 |
+
deploy_to_hf.bat YOUR_USERNAME boss-food-ordering-agent-v2
|
| 275 |
+
```
|
| 276 |
+
|
| 277 |
+
**Linux/Mac:**
|
| 278 |
+
```bash
|
| 279 |
+
./deploy_to_hf.sh YOUR_USERNAME boss-food-ordering-agent-v2
|
| 280 |
+
```
|
| 281 |
+
|
| 282 |
+
Replace `YOUR_USERNAME` with your Hugging Face username.
|
| 283 |
+
|
| 284 |
+
---
|
| 285 |
+
|
| 286 |
+
**Version**: 2.0.0
|
| 287 |
+
**Status**: Ready for Production β
|
| 288 |
+
**Files**: 39 essential files
|
| 289 |
+
**Size**: ~6000 lines of code
|
| 290 |
+
**Last Updated**: 2026-04-22
|
| 291 |
+
|
| 292 |
+
Good luck! π
|