|
| 1 | += Vibe-Coding Risk Radar |
| 2 | +:toc: macro |
| 3 | +:toclevels: 2 |
| 4 | +:icons: font |
| 5 | + |
| 6 | +MECE risk framework for AI-generated code — 5 dimensions, 4 tiers, actionable mitigations. |
| 7 | + |
| 8 | +toc::[] |
| 9 | + |
| 10 | +== What is this? |
| 11 | + |
| 12 | +An interactive React component that classifies vibe-coding risk across 5 orthogonal dimensions and maps results to concrete mitigation tiers. |
| 13 | +Accompanied by full AsciiDoc documentation with 30+ verified references. |
| 14 | + |
| 15 | +=== Features |
| 16 | + |
| 17 | +* *5 MECE Dimensions:* Code type, language safety, deployment context, data sensitivity, blast radius |
| 18 | +* *4 Cumulative Tiers:* Each tier includes all mitigations of lower tiers |
| 19 | +* *Radar Chart:* SVG visualization of the risk profile |
| 20 | +* *Presets:* Quick scenarios (Landing Page → Payment Service) |
| 21 | +* *DE / EN:* Full bilingual support, switchable at runtime |
| 22 | +* *Inline Documentation:* Slide-out sidebar with all 6 doc sections |
| 23 | +* *Mobile-friendly:* Responsive layout with stacked sliders |
| 24 | + |
| 25 | +== Quick Start |
| 26 | + |
| 27 | +=== Local Development |
| 28 | + |
| 29 | +[source,bash] |
| 30 | +---- |
| 31 | +npm install |
| 32 | +npm run dev |
| 33 | +---- |
| 34 | + |
| 35 | +Opens at `http://localhost:5173`. |
| 36 | + |
| 37 | +=== Production Build |
| 38 | + |
| 39 | +[source,bash] |
| 40 | +---- |
| 41 | +npm run build |
| 42 | +npm run preview |
| 43 | +---- |
| 44 | + |
| 45 | +Output in `dist/`. |
| 46 | + |
| 47 | +== GitHub Pages Deployment |
| 48 | + |
| 49 | +The included GitHub Action (`.github/workflows/deploy.yml`) handles everything automatically: |
| 50 | + |
| 51 | +. Builds the React app with Vite |
| 52 | +. Renders the AsciiDoc documentation with Asciidoctor |
| 53 | +. Deploys both to GitHub Pages |
| 54 | + |
| 55 | +=== Setup |
| 56 | + |
| 57 | +. Go to *Settings → Pages* in your GitHub repository |
| 58 | +. Under *Build and deployment*, select *GitHub Actions* as the source |
| 59 | +. Push to `main` — the workflow runs automatically |
| 60 | + |
| 61 | +After deployment: |
| 62 | + |
| 63 | +* *App:* `https://<user>.github.io/<repo>/` |
| 64 | +* *Docs:* `https://<user>.github.io/<repo>/docs/risk-radar.html` |
| 65 | + |
| 66 | +== Project Structure |
| 67 | + |
| 68 | +[source] |
| 69 | +---- |
| 70 | +. |
| 71 | +├── .github/workflows/deploy.yml # GitHub Pages CI/CD |
| 72 | +├── docs/ |
| 73 | +│ └── risk-radar.adoc # Full AsciiDoc documentation (30+ refs) |
| 74 | +├── src/ |
| 75 | +│ ├── RiskRadar.jsx # Main React component (self-contained) |
| 76 | +│ ├── main.jsx # React entry point |
| 77 | +│ └── index.css # Minimal reset |
| 78 | +├── index.html # Vite entry HTML |
| 79 | +├── package.json |
| 80 | +├── vite.config.js |
| 81 | +└── README.adoc |
| 82 | +---- |
| 83 | + |
| 84 | +== Documentation |
| 85 | + |
| 86 | +The `docs/risk-radar.adoc` file contains the full framework documentation: |
| 87 | + |
| 88 | +* Empirical evidence (Veracode, CodeRabbit, METR, Perry et al.) |
| 89 | +* 5×5 dimension matrix with detailed descriptions |
| 90 | +* 4-tier mitigation model with deterministic, probabilistic, and organizational measures |
| 91 | +* Regulatory context (EU AI Act, HIPAA, PCI-DSS, IEC 61508, DO-178C, ISO 26262) |
| 92 | +* References: 30+ verified URLs to primary sources |
| 93 | + |
| 94 | +== License |
| 95 | + |
| 96 | +MIT |
0 commit comments