SimpleProject / DEPLOY.md
gladguy's picture
Add deployment instructions
b57f223
|
Raw
History Blame Contribute Delete
2.78 kB
# πŸš€ Quick Deployment Instructions
## βœ… Repository Status
**SimpleHF is now synced with Hugging Face Space!**
Repository: https://huggingface.co/spaces/gladguy/SimpleProject
Branch: main
Latest commit: 119408d - "Add AnatomyBot - MBBS Anatomy Tutor with AI-powered learning features"
## πŸ“€ Push to Hugging Face
Run this command to deploy:
```bash
git push origin main
```
If you need authentication, use your Hugging Face credentials:
- Username: `gladguy` (or your username)
- Password: Your Hugging Face access token (get from https://huggingface.co/settings/tokens)
## πŸ”‘ Configure API Keys (CRITICAL!)
After pushing, you MUST add these secrets in your Space settings:
1. Go to: https://huggingface.co/spaces/gladguy/SimpleProject/settings
2. Scroll to **Repository secrets**
3. Add:
- Name: `SERPAPI_KEY` β†’ Value: Your SERPAPI key
- Name: `HYPERBOLIC_API_KEY` β†’ Value: Your Hyperbolic key
## ✨ What's Included
βœ… `app.py` - Main AnatomyBot application with:
- Anatomy-only question validation
- Google Images search via SERPAPI
- AI content generation via Hyperbolic (Llama 3.3 70B)
- Interactive Gradio interface
βœ… `requirements.txt` - All Python dependencies
βœ… `README.md` - Space description with Hugging Face configuration
βœ… `setup.py` - Helper script to configure API keys locally
βœ… `.gitignore` - Prevents committing .env and other sensitive files
## 🎯 After Deployment
Your Space will be live at:
**https://huggingface.co/spaces/gladguy/SimpleProject**
Test with these questions:
- "Show me the Circle of Willis"
- "Brachial plexus anatomy"
- "Carpal bones arrangement"
## πŸ“ Local Testing (Before Pushing)
To test locally first:
1. Configure your API keys:
```bash
python setup.py
# OR manually edit .env file
```
2. Run the app:
```bash
python app.py
```
3. Open http://localhost:7860 in your browser
## πŸ”§ Troubleshooting
**Issue: Authentication failed when pushing**
```bash
# Use access token in URL
git remote set-url origin https://gladguy:YOUR_TOKEN@huggingface.co/spaces/gladguy/SimpleProject
git push origin main
```
**Issue: Space shows error after deployment**
- Check that both API keys are set in Space secrets
- Check the build logs in the Space
## πŸ“Š Files Ready to Deploy
```
SimpleHF/
β”œβ”€β”€ .gitignore βœ… Committed
β”œβ”€β”€ README.md βœ… Committed (with HF config)
β”œβ”€β”€ app.py βœ… Committed
β”œβ”€β”€ requirements.txt βœ… Committed
β”œβ”€β”€ setup.py βœ… Committed
└── .env ❌ Not committed (contains secrets)
```
## πŸŽ‰ Ready to Deploy!
Everything is committed and ready. Just run:
```bash
git push origin main
```
Then configure your API keys in the Space settings!