Skip to content

Commit 28cf04f

Browse files
committed
Simplify frontend section: link + config steps only
1 parent 5091492 commit 28cf04f

1 file changed

Lines changed: 10 additions & 44 deletions

File tree

README.md

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -251,60 +251,26 @@ ShieldCI generates two files in the target repo:
251251

252252
## Frontend — ShieldCI Dashboard
253253

254-
ShieldCI comes with a companion **Next.js dashboard** ([Zenith1415/Shield-CI](https://github.com/Zenith1415/Shield-CI)) that gives you a full security operations view of your repositories. The engine pushes results to the dashboard API after every scan.
254+
The companion dashboard is at **[Zenith1415/Shield-CI](https://github.com/Zenith1415/Shield-CI)** — a Next.js app that visualizes scan results, tracks vulnerabilities, and manages connected repos.
255255

256-
### Tech Stack
256+
### Connecting Engine → Dashboard
257257

258-
| Layer | Technology |
259-
|-------|-----------|
260-
| Framework | **Next.js 14** (App Router) |
261-
| Auth | **NextAuth.js** with GitHub OAuth |
262-
| Database | **MongoDB** (Mongoose ODM) |
263-
| UI | Custom components + Lucide icons + Recharts |
258+
1. Clone and run the dashboard (see its README for setup)
259+
2. Set three env vars before running ShieldCI (or add them to your CI secrets):
264260

265-
### Dashboard Pages
266-
267-
| Page | What It Shows |
268-
|------|--------------|
269-
| **Overview** | Security score gauge (0–100), score-over-time line chart, stat cards (vulns found, issue scans, total scans), recent activity feed, per-repo summary |
270-
| **Repositories** | All connected repos with security scores, severity breakdown bars, vuln counts (pending / fix PR raised / resolved), scan history sparklines |
271-
| **Vulnerabilities** | Filterable table of all detected vulnerabilities — filter by severity (Critical/High/Medium/Low), status (Pending/Fix PR Raised/Resolved), and repo |
272-
| **Fix PR Tracker** | Track auto-raised fix PRs — status (Open/Merged), branch, severity, time since raised |
273-
| **Scan History** | Full audit trail of every scan — commit, branch, duration, vulns found, status (Clean/Issues Found/Failed), per-repo color coding |
274-
| **Connect Repo** | Link GitHub repositories via OAuth — auto-provisions the workflow and secrets |
275-
| **Installation** | Step-by-step setup guide — connect GitHub, add self-hosted runner, configure workflow, open a PR |
276-
| **Settings** | Scan triggers (on push / on PR), auto-raise fix PRs, severity threshold, email & notification preferences, API key management |
277-
278-
### How Results Flow
279-
280-
```
281-
Rust Engine Dashboard API MongoDB
282-
────────── ───────────── ───────
283-
scan completes │ │
284-
│ │ │
285-
├─── POST /api/scans ──────────▶│── Scan.create() ─────────▶│
286-
│ (report + vulns) │── Vulnerability.insert() ─▶│
287-
│ │ │
288-
│ Dashboard UI │
289-
│ ───────────── │
290-
│ │ │
291-
│ GET /api/dashboard/stats ◀──────────────┤
292-
│ GET /api/repos/stats ◀──────────────┤
293-
│ GET /api/vulnerabilities ◀──────────────┤
294-
│ GET /api/scans ◀──────────────┤
261+
```bash
262+
export SHIELDCI_API_URL=http://localhost:3000 # dashboard URL
263+
export SHIELDCI_API_KEY=your-secret-key # matches the dashboard's key
264+
export SHIELDCI_REPO=owner/repo # e.g. Akshat-Raj/ShieldCI
295265
```
296266

297-
### Pushing Results
267+
3. After a scan completes, push the results:
298268

299269
```bash
300-
# After a scan, push results to the dashboard
301-
SHIELDCI_API_URL=http://localhost:3000 \
302-
SHIELDCI_API_KEY=your-secret-key \
303-
SHIELDCI_REPO=owner/repo \
304270
python3 push_results.py
305271
```
306272

307-
In CI, this is handled automatically by the GitHub Actions workflow using a **self-hosted runner** — keeping everything local.
273+
In CI, this happens automatically via the GitHub Actions workflow — no manual step needed.
308274

309275
---
310276

0 commit comments

Comments
 (0)