pdf-summarizer / QUICK_START.md
aladhefafalquran
Add comprehensive documentation guides for PDF Summarizer
5980d17
# ⚑ Quick Start Guide
## 🎯 Deploy to Hugging Face Spaces in 5 Minutes
### Option 1: Web Upload (Easiest)
1. **Create Space**
- Go to https://huggingface.co/new-space
- Name: `pdf-summarizer` (or your choice)
- SDK: Select **Gradio**
- Hardware: **CPU basic** (free)
- Click **Create Space**
2. **Upload Files via Web**
- Click **Files** tab in your new space
- Click **Add file** β†’ **Upload files**
- Upload these files:
- `app.py`
- `requirements.txt`
- `README.md`
- Click **Commit changes to main**
3. **Wait for Build**
- Space will build automatically (2-5 minutes)
- You'll see "Building..." then "Running"
- Done! Your app is live!
### Option 2: Git Upload (For developers)
```bash
# 1. Clone your space
git clone https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
cd YOUR_SPACE_NAME
# 2. Copy files
cp /path/to/PDF-Summarizer-HF-Space/* .
# 3. Push to Hugging Face
git add .
git commit -m "Initial commit"
git push
```
## πŸ“ Files You Need
**Required:**
- `app.py` - Main application
- `requirements.txt` - Dependencies
**Recommended:**
- `README.md` - Documentation
- `.gitignore` - Git ignore rules
## πŸ”‘ Getting Your Access Token
If you use Git method:
1. Go to https://huggingface.co/settings/tokens
2. Click **New token**
3. Name: "Spaces"
4. Permission: **write**
5. Click **Generate**
6. Copy token
7. Use as password when pushing
## βœ… Testing Your Space
After deployment:
1. Upload a test PDF
2. Select BART model
3. Click "Generate Summary"
4. Download the result
If it works - you're done! πŸŽ‰
## 🚨 Common Issues
**Build Failed?**
- Check the Logs tab
- Usually a typo in requirements.txt
**Models Not Loading?**
- Just wait - first build downloads ~2.6GB
- Can take 5-10 minutes
**Out of Memory?**
- Upgrade to CPU upgrade ($0.03/hr)
- Or use only BART (remove Long-T5)
## πŸ’‘ Tips
- Start with free tier
- Upgrade if you get many users
- Set space to sleep after inactivity (saves resources)
- Share your space URL with friends!
## πŸ“ž Need Help?
Check the full `DEPLOYMENT_GUIDE.md` for detailed instructions.
---
**Your Space URL will be:**
```
https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
```
Example:
```
https://huggingface.co/spaces/mustafa/pdf-summarizer
```