pr-guardian

🛡️ PR Guardian

AI-powered code review system. Point it at a GitHub URL or drop local files — parallel AI agents find bugs, security issues, and test gaps, then propose fixes.

---

Quick Start (one command)

1. Get a free Groq API key

Go to console.groq.com/keys → Create API Key → copy it.
It’s free, no credit card required.

2. Add your key

Create backend/.env:

GROQ_API_KEY=gsk_your_key_here

3. Run

cd pr-guardian
python start.py

That’s it. Opens http://localhost:3000 automatically.
Press Ctrl+C to stop both servers.

Windows: double-click start.bat instead.

---

What it does

Paste GitHub URL  OR  drop local files
         ↓
3–4 AI agents run in parallel (Code · Security · Tests · Performance)
         ↓
Flappy Guardian game plays while you wait
         ↓
Results appear after game ends (or skip)
         ↓
Fix issues → download patched files (local) or commit to GitHub (PAT required)

---

AI Provider

Provider	Cost	Set up
Groq ✅ default	Free	GROQ_API_KEY=gsk_... in backend/.env
OpenAI fallback	Paid (~$0.05–0.20/analysis)	OPENAI_API_KEY=sk-... in backend/.env

Groq runs Llama 3.1 70B — fast and free, no credit card needed.

---

GitHub token (optional)

Only needed to:

• Commit AI fixes back to a PR branch
• Use the “Seed Demo Repo” button

The app prompts for it only when you click “Apply Fix” — never upfront.
Get one: GitHub → Settings → Developer settings → Personal access tokens → Generate new (classic) with repo scope.

---

Deployment

• Frontend → Vercel (auto-deploy from frontend/)
• Backend → Railway (auto-deploy from backend/, set GROQ_API_KEY env var)

---

Architecture

① GitHub URL  /  ② Local files  /  ③ File path
                    ↓
             FastAPI Backend
                    ↓ asyncio.gather (parallel)
  ┌──────────┬──────────┬──────────┬────────────┐
  Code       Security   Test       Performance
  Agent      Agent      Agent      Agent
  └──────────┴──────────┴──────────┴────────────┘
                    ↓
         Fix Agent + Regression Check
                    ↓
         Risk Score + GitHub Report
                    ↓
      Download fix (local) or Commit to branch (GitHub)

”# pr-guardian”