Skip to content

Commit 80e90f6

Browse files
committed
docs: fix outdated counts and versions across README and SETUP_GUIDE
- API routes: 14 -> 15 (add /api/health) - Hooks: 4 -> 5 (add useTheme) - E2E tests: 97 -> ~71 (actual count from spec files) - Dexie: v5 -> v4 (package.json has ^4.3.0) - Node: 20+ -> 22+ - Charts: remove Chart.js reference (only Recharts installed) - Add health route to API routes table
1 parent 84da42f commit 80e90f6

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ AutiSense is a web application that captures behavioral biomarkers using real-ti
2525
- **Multimodal fusion** -- Body pose (70%) and facial expression (30%) late fusion for ASD risk scoring
2626
- **AI-generated clinical reports** -- Amazon Bedrock (Nova Pro) produces DSM-5-aligned reports with severity mapping; downloadable as PDF
2727
- **Kids dashboard** -- 13 therapy games, AI chat with animated animal avatars, speech practice, progress tracking, weekly reports, and a nearby-institutes map
28-
- **Offline-first** -- IndexedDB (Dexie v5) stores all data locally; DynamoDB sync when connectivity is available
28+
- **Offline-first** -- IndexedDB (Dexie v4) stores all data locally; DynamoDB sync when connectivity is available
2929
- **Privacy-first** -- Zero data egress during screening; cloud sync is opt-in with explicit consent
3030

3131
---
@@ -45,9 +45,9 @@ AutiSense is a web application that captures behavioral biomarkers using real-ti
4545
| Generative AI | Amazon Bedrock (Nova Lite + Nova Pro) |
4646
| Text-to-Speech | Amazon Polly (Neural, Joanna voice) |
4747
| Auth | Custom Google OAuth 2.0 + DynamoDB sessions |
48-
| Charts | Recharts (dashboard) + Chart.js (detector) |
48+
| Charts | Recharts (dashboard + detector) |
4949
| PDF | pdf-lib (server-side generation) |
50-
| E2E Testing | Playwright 1.58.2 (97 tests) |
50+
| E2E Testing | Playwright 1.58.2 (~71 tests) |
5151
| Unit Testing | Vitest 3.2.4 (68 tests) |
5252
| Hosting | AWS Amplify (WEB_COMPUTE SSR) |
5353

@@ -109,7 +109,7 @@ Additional features: AI chat with animal avatars (dog/cat/rabbit/parrot), speech
109109

110110
### Prerequisites
111111

112-
- Node.js 20+
112+
- Node.js 22+
113113
- npm
114114

115115
### Installation
@@ -159,7 +159,7 @@ Open [http://localhost:3000](http://localhost:3000).
159159
```bash
160160
npm run build
161161
npm run test:unit # 68 Vitest unit tests
162-
npx playwright test # 97 Playwright E2E tests
162+
npx playwright test # ~71 Playwright E2E tests
163163
```
164164

165165
---
@@ -169,14 +169,14 @@ npx playwright test # 97 Playwright E2E tests
169169
```
170170
AutiSense/
171171
├── app/
172-
│ ├── api/ 14 API routes (auth, chat, feed, nearby, report, sync, tts)
172+
│ ├── api/ 15 API routes (auth, chat, feed, health, nearby, report, sync, tts)
173173
│ ├── auth/ Login page
174174
│ ├── components/ 11 shared UI components
175175
│ ├── contexts/ AuthContext (Google OAuth)
176176
│ ├── dashboard/ Clinician dashboard + child profiles
177177
│ ├── feed/ Community feed (posts, reactions)
178178
│ ├── games/ 7 therapy games (clinician-facing)
179-
│ ├── hooks/ 4 custom hooks (auth, camera, inference)
179+
│ ├── hooks/ 5 custom hooks (auth, camera, inference, theme)
180180
│ ├── intake/ 10-step screening flow
181181
│ ├── kid-dashboard/ Kids hub (6 games, AI chat, progress, reports, map)
182182
│ ├── lib/ Business logic
@@ -192,7 +192,7 @@ AutiSense/
192192
├── public/models/ 4 ONNX models (~47 MB total)
193193
├── server/ Lambda handler + DynamoDB setup script
194194
├── __tests__/ 7 Vitest unit test files (68 tests)
195-
├── tests/ 4 Playwright E2E spec files (97 tests)
195+
├── tests/ 4 Playwright E2E spec files (~71 tests)
196196
├── workers/ ONNX inference Web Worker
197197
└── docs/ DOCS.md, SETUP_GUIDE.md, Amazon_usage.md
198198
```
@@ -265,6 +265,7 @@ See [`docs/Amazon_usage.md`](docs/Amazon_usage.md) for the complete AWS architec
265265
| `/api/feed` | GET/POST | DynamoDB | In-memory store |
266266
| `/api/sync` | POST | DynamoDB | Error response |
267267
| `/api/nearby` | POST | -- (Overpass API) | -- |
268+
| `/api/health` | GET | DynamoDB | Degraded status |
268269

269270
---
270271

docs/SETUP_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Environment variables are configured in the Amplify Console:
4444

4545
```bash
4646
npm run test:unit # Vitest unit tests (68 tests, also runs in Amplify preBuild)
47-
npx playwright test # Playwright E2E tests (~97 tests)
47+
npx playwright test # Playwright E2E tests (~71 tests)
4848
npm run lint # ESLint
4949
npm run type-check # TypeScript
5050
```

0 commit comments

Comments
 (0)