fleetmind-dispatch-ai / QUICK_START.md
mashrur950's picture
Initial commit: FleetMind MCP with GitHub Actions auto-sync
d69447e
|
raw
history blame
2.87 kB
# GitHub Actions Setup - Quick Start
## ⚑ Complete These 4 Steps (15 minutes)
### STEP 1: Create GitHub Repository (2 min)
1. Go to: https://github.com/new
2. Name: `fleetmind-mcp`
3. Visibility: Public
4. **DON'T** initialize with README
5. Click "Create repository"
6. **SAVE YOUR USERNAME!**
---
### STEP 2: Get Hugging Face Token (2 min)
1. Go to: https://huggingface.co/settings/tokens
2. Click "Create new token"
3. Name: `GitHub Actions Sync`
4. Type: **Write**
5. Click "Generate token"
6. **COPY THE TOKEN** (starts with `hf_...`)
---
### STEP 3: Push to GitHub (3 min)
**Open PowerShell and run:**
```powershell
# Navigate to repo
cd F:\github-fleetmind-team
# Add and commit
git add .
git commit -m "Initial commit with GitHub Actions"
# Add GitHub remote (REPLACE YOUR-USERNAME!)
git remote add origin https://github.com/YOUR-USERNAME/fleetmind-mcp.git
# Push to GitHub
git branch -M main
git push -u origin main
```
**You'll be asked for credentials:**
- Username: Your GitHub username
- Password: Your GitHub Personal Access Token
- Get it at: https://github.com/settings/tokens
- Or use GitHub Desktop/CLI for easier auth
---
### STEP 4: Add HF_TOKEN to GitHub (3 min)
1. **Go to:** `https://github.com/YOUR-USERNAME/fleetmind-mcp/settings/secrets/actions`
2. **Click:** "New repository secret"
3. **Fill in:**
- Name: `HF_TOKEN`
- Secret: Paste your Hugging Face token from Step 2
4. **Click:** "Add secret"
---
## βœ… Test It Works (5 min)
```powershell
cd F:\github-fleetmind-team
# Make a small change
echo "`n## Auto-synced from GitHub" >> README.md
# Commit and push
git add README.md
git commit -m "Test: Auto-sync"
git push origin main
```
**Check:**
1. GitHub Actions: `https://github.com/YOUR-USERNAME/fleetmind-mcp/actions`
- Should show green checkmark βœ…
2. HF Space: https://huggingface.co/spaces/MCP-1st-Birthday/fleetmind-dispatch-ai
- Should have new commit
---
## πŸŽ‰ Done! Now Your Team Can Collaborate
**Team members:**
```bash
# Clone GitHub repo
git clone https://github.com/YOUR-USERNAME/fleetmind-mcp.git
cd fleetmind-mcp
# Make changes
# ... edit files ...
# Push to GitHub (auto-syncs to HF Space!)
git add .
git commit -m "Add feature"
git push
```
**Every push to GitHub automatically updates HF Space!** ✨
---
## πŸ“‹ Add Team Members to GitHub
1. Go to: `https://github.com/YOUR-USERNAME/fleetmind-mcp/settings/access`
2. Click "Add people"
3. Enter their GitHub username
4. Role: **Write**
5. Click "Add"
---
## πŸ†˜ Quick Troubleshooting
**GitHub Actions fails?**
β†’ Check HF_TOKEN is set correctly in GitHub Secrets
**Can't push to GitHub?**
β†’ Create GitHub Personal Access Token: https://github.com/settings/tokens
**Files too large?**
β†’ Use Git LFS (see full guide)
---
**Full documentation:** See `GITHUB_ACTIONS_SETUP.md`
**Ready to build!** πŸš€