Spaces:
Sleeping
Sleeping
Ming Wang commited on
Update README.md to improve structure and clarity
Browse filesReorganized Tech Stack and Project Structure sections in README.md.
README.md
CHANGED
|
@@ -22,48 +22,6 @@ The dashboard displays real-time KPI cards, traffic/incident charts, and alert f
|
|
| 22 |
|
| 23 |
---
|
| 24 |
|
| 25 |
-
## Tech Stack
|
| 26 |
-
|
| 27 |
-
| Layer | Technology |
|
| 28 |
-
|-------|-----------|
|
| 29 |
-
| Frontend | Angular 21, Angular Material (Material 3), ngx-echarts |
|
| 30 |
-
| Backend | json-server (fake REST API from `backend/db.json`) |
|
| 31 |
-
| Dev Environment | GitHub Codespaces, Dev Containers (Node.js 20) |
|
| 32 |
-
| AI Governance | copilot-instructions.md, prompt files, agent profiles |
|
| 33 |
-
|
| 34 |
-
---
|
| 35 |
-
|
| 36 |
-
## Project Structure
|
| 37 |
-
|
| 38 |
-
```
|
| 39 |
-
backend/
|
| 40 |
-
db.json ← Fake REST data (KPIs, traffic, incidents, alerts)
|
| 41 |
-
|
| 42 |
-
frontend/src/app/
|
| 43 |
-
core/
|
| 44 |
-
models/api.models.ts ← All typed DTOs
|
| 45 |
-
services/dashboard-api.service.ts ← API abstraction layer
|
| 46 |
-
dashboard/
|
| 47 |
-
dashboard.ts / .html / .scss ← Main dashboard page
|
| 48 |
-
kpi-card/ ← Generic KPI card (input-driven)
|
| 49 |
-
chart-widget/ ← Generic chart widget (input-driven)
|
| 50 |
-
alert-list/ ← Alert list component
|
| 51 |
-
chart-config.factory.ts ← Pure functions generating ECharts options
|
| 52 |
-
|
| 53 |
-
.github/
|
| 54 |
-
copilot-instructions.md ← 20 production code rules for Copilot
|
| 55 |
-
prompts/ ← 3 demo prompt files
|
| 56 |
-
agents/ ← Custom agent profile
|
| 57 |
-
skills/ ← Optional widget scaffolding skill
|
| 58 |
-
|
| 59 |
-
docs/
|
| 60 |
-
demo-script.md ← Step-by-step demo script (3 scenarios)
|
| 61 |
-
review-checklist.md ← Code review checklist
|
| 62 |
-
ai-working-rules.md ← AI working rules summary
|
| 63 |
-
```
|
| 64 |
-
|
| 65 |
-
---
|
| 66 |
-
|
| 67 |
## Getting Started
|
| 68 |
|
| 69 |
### Option A: GitHub Codespaces (Recommended)
|
|
@@ -138,6 +96,48 @@ Open Copilot Chat and paste:
|
|
| 138 |
|
| 139 |
---
|
| 140 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 141 |
## AI Governance
|
| 142 |
|
| 143 |
This repo enforces 20 production code rules via `.github/copilot-instructions.md`. Key rules:
|
|
|
|
| 22 |
|
| 23 |
---
|
| 24 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 25 |
## Getting Started
|
| 26 |
|
| 27 |
### Option A: GitHub Codespaces (Recommended)
|
|
|
|
| 96 |
|
| 97 |
---
|
| 98 |
|
| 99 |
+
## Tech Stack
|
| 100 |
+
|
| 101 |
+
| Layer | Technology |
|
| 102 |
+
|-------|-----------|
|
| 103 |
+
| Frontend | Angular 21, Angular Material (Material 3), ngx-echarts |
|
| 104 |
+
| Backend | json-server (fake REST API from `backend/db.json`) |
|
| 105 |
+
| Dev Environment | GitHub Codespaces, Dev Containers (Node.js 20) |
|
| 106 |
+
| AI Governance | copilot-instructions.md, prompt files, agent profiles |
|
| 107 |
+
|
| 108 |
+
---
|
| 109 |
+
|
| 110 |
+
## Project Structure
|
| 111 |
+
|
| 112 |
+
```
|
| 113 |
+
backend/
|
| 114 |
+
db.json ← Fake REST data (KPIs, traffic, incidents, alerts)
|
| 115 |
+
|
| 116 |
+
frontend/src/app/
|
| 117 |
+
core/
|
| 118 |
+
models/api.models.ts ← All typed DTOs
|
| 119 |
+
services/dashboard-api.service.ts ← API abstraction layer
|
| 120 |
+
dashboard/
|
| 121 |
+
dashboard.ts / .html / .scss ← Main dashboard page
|
| 122 |
+
kpi-card/ ← Generic KPI card (input-driven)
|
| 123 |
+
chart-widget/ ← Generic chart widget (input-driven)
|
| 124 |
+
alert-list/ ← Alert list component
|
| 125 |
+
chart-config.factory.ts ← Pure functions generating ECharts options
|
| 126 |
+
|
| 127 |
+
.github/
|
| 128 |
+
copilot-instructions.md ← 20 production code rules for Copilot
|
| 129 |
+
prompts/ ← 3 demo prompt files
|
| 130 |
+
agents/ ← Custom agent profile
|
| 131 |
+
skills/ ← Optional widget scaffolding skill
|
| 132 |
+
|
| 133 |
+
docs/
|
| 134 |
+
demo-script.md ← Step-by-step demo script (3 scenarios)
|
| 135 |
+
review-checklist.md ← Code review checklist
|
| 136 |
+
ai-working-rules.md ← AI working rules summary
|
| 137 |
+
```
|
| 138 |
+
|
| 139 |
+
---
|
| 140 |
+
|
| 141 |
## AI Governance
|
| 142 |
|
| 143 |
This repo enforces 20 production code rules via `.github/copilot-instructions.md`. Key rules:
|