You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-44Lines changed: 10 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -251,60 +251,26 @@ ShieldCI generates two files in the target repo:
251
251
252
252
## Frontend — ShieldCI Dashboard
253
253
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.
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):
264
260
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() ─────────▶│
0 commit comments