Nyk commited on
Commit
c501a1b
Β·
1 Parent(s): d475641

docs: fix README inaccuracies and add engines field

Browse files

- Fix migration count: 11 β†’ 14 (actual count in migrations.ts)
- Fix panel count: 23 β†’ 26 (actual count in components/panels/)
- Fix API route count: 25+ β†’ 30+ (actual count in app/api/)
- Update testing line to mention 52 E2E tests
- Collapse completed issues list into link to v1.0.0 release notes
- Add engines.node >= 20 to package.json (matches CI)

Files changed (2) hide show
  1. README.md +7 -27
  2. package.json +3 -0
README.md CHANGED
@@ -97,16 +97,16 @@ mission-control/
97
  β”‚ β”œβ”€β”€ app/
98
  β”‚ β”‚ β”œβ”€β”€ page.tsx # SPA shell β€” routes all panels
99
  β”‚ β”‚ β”œβ”€β”€ login/page.tsx # Login page
100
- β”‚ β”‚ └── api/ # 25+ REST API routes
101
  β”‚ β”œβ”€β”€ components/
102
  β”‚ β”‚ β”œβ”€β”€ layout/ # NavRail, HeaderBar, LiveFeed
103
  β”‚ β”‚ β”œβ”€β”€ dashboard/ # Overview dashboard
104
- β”‚ β”‚ β”œβ”€β”€ panels/ # 23 feature panels
105
  β”‚ β”‚ └── chat/ # Agent chat UI
106
  β”‚ β”œβ”€β”€ lib/
107
  β”‚ β”‚ β”œβ”€β”€ auth.ts # Session + API key auth, RBAC
108
  β”‚ β”‚ β”œβ”€β”€ db.ts # SQLite (better-sqlite3, WAL mode)
109
- β”‚ β”‚ β”œβ”€β”€ migrations.ts # 11 schema migrations
110
  β”‚ β”‚ β”œβ”€β”€ scheduler.ts # Background task scheduler
111
  β”‚ β”‚ β”œβ”€β”€ webhooks.ts # Outbound webhook delivery
112
  β”‚ β”‚ └── websocket.ts # Gateway WebSocket client
@@ -126,7 +126,7 @@ mission-control/
126
  | Charts | Recharts 3 |
127
  | Real-time | WebSocket + Server-Sent Events |
128
  | Auth | scrypt hashing, session tokens, RBAC |
129
- | Testing | Vitest + Playwright |
130
 
131
  ## Authentication
132
 
@@ -311,29 +311,9 @@ pnpm quality:gate # All checks
311
 
312
  ## Roadmap
313
 
314
- See [open issues](https://github.com/builderz-labs/mission-control/issues) for the full list.
315
-
316
- #### Recently Completed
317
-
318
- - [x] Auth guards on all GET endpoints (#4)
319
- - [x] Timing-safe API key comparison (#5)
320
- - [x] XSS sanitization in memory browser (#6)
321
- - [x] Legacy cookie auth removal (#7)
322
- - [x] Login rate limiting (#8)
323
- - [x] SSRF protection on gateway health probe (#9)
324
- - [x] SQL injection fix in migration (#10)
325
- - [x] TypeScript strict mode (#11)
326
- - [x] Unit test stubs (#12)
327
- - [x] Pagination total counts (#13)
328
- - [x] N+1 query fixes (#14)
329
- - [x] CSP hardening (#15)
330
- - [x] Code of Conduct (#16)
331
- - [x] Issue templates (#17)
332
- - [x] DELETE body standardization (#18)
333
- - [x] Query limit caps (#19)
334
- - [x] CSRF Origin validation (#20)
335
-
336
- #### Up Next
337
 
338
  - [ ] Fill in Vitest unit test stubs with real assertions
339
  - [ ] API token rotation UI
 
97
  β”‚ β”œβ”€β”€ app/
98
  β”‚ β”‚ β”œβ”€β”€ page.tsx # SPA shell β€” routes all panels
99
  β”‚ β”‚ β”œβ”€β”€ login/page.tsx # Login page
100
+ β”‚ β”‚ └── api/ # 30+ REST API routes
101
  β”‚ β”œβ”€β”€ components/
102
  β”‚ β”‚ β”œβ”€β”€ layout/ # NavRail, HeaderBar, LiveFeed
103
  β”‚ β”‚ β”œβ”€β”€ dashboard/ # Overview dashboard
104
+ β”‚ β”‚ β”œβ”€β”€ panels/ # 26 feature panels
105
  β”‚ β”‚ └── chat/ # Agent chat UI
106
  β”‚ β”œβ”€β”€ lib/
107
  β”‚ β”‚ β”œβ”€β”€ auth.ts # Session + API key auth, RBAC
108
  β”‚ β”‚ β”œβ”€β”€ db.ts # SQLite (better-sqlite3, WAL mode)
109
+ β”‚ β”‚ β”œβ”€β”€ migrations.ts # 14 schema migrations
110
  β”‚ β”‚ β”œβ”€β”€ scheduler.ts # Background task scheduler
111
  β”‚ β”‚ β”œβ”€β”€ webhooks.ts # Outbound webhook delivery
112
  β”‚ β”‚ └── websocket.ts # Gateway WebSocket client
 
126
  | Charts | Recharts 3 |
127
  | Real-time | WebSocket + Server-Sent Events |
128
  | Auth | scrypt hashing, session tokens, RBAC |
129
+ | Testing | Vitest + Playwright (52 E2E tests) |
130
 
131
  ## Authentication
132
 
 
311
 
312
  ## Roadmap
313
 
314
+ See [open issues](https://github.com/builderz-labs/mission-control/issues) for planned work and the [v1.0.0 release notes](https://github.com/builderz-labs/mission-control/releases/tag/v1.0.0) for what shipped.
315
+
316
+ **Up next:**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
317
 
318
  - [ ] Fill in Vitest unit test stubs with real assertions
319
  - [ ] API token rotation UI
package.json CHANGED
@@ -50,6 +50,9 @@
50
  "vite-tsconfig-paths": "^5.1.4",
51
  "vitest": "^2.1.5"
52
  },
 
 
 
53
  "keywords": [
54
  "openclaw",
55
  "agent",
 
50
  "vite-tsconfig-paths": "^5.1.4",
51
  "vitest": "^2.1.5"
52
  },
53
+ "engines": {
54
+ "node": ">=20"
55
+ },
56
  "keywords": [
57
  "openclaw",
58
  "agent",