9d392eab39
- AGENTS.md: full AI agent onboarding guide following ecosystem conventions - README.md: quick start, architecture overview, env setup, test commands - ROADMAP.md: added commit references for identity lock, MCP tools, platform integrations, blob client - Marked resolved blockers (product identity, blob artifacts)
1.6 KiB
1.6 KiB
NoteLett
Structured notes platform for humans and AI agents — part of the ByteLyst ecosystem.
Quick Start
# Backend (port 4016)
cd backend && npm install && npm run dev
# Web (port 3000)
cd web && npm install && npm run dev -- --webpack
# Mobile
cd mobile && npm install && npm start
Architecture
| Surface | Stack | Port |
|---|---|---|
| Backend | Fastify 5 + TypeScript ESM | 4016 |
| Web | Next.js 16 + React 19 | 3000 |
| Mobile | Expo + React Native | 8081 |
| Platform | platform-service (shared) | 4003 |
| Extraction | extraction-service (shared) | 4005 |
Key Features
- 6 backend modules: notes, workspaces, relationships, tasks, artifacts, agent actions
- 8 MCP tools: list, get, search, create_draft, update, link_notes, extract_tasks, attach_artifact
- Agent audit trail: every write tool records agent action history
- Datastore abstraction: Cosmos DB in production, in-memory for tests
- Platform integrations: auth (JWT), telemetry, diagnostics, feature flags, kill-switch, blob storage
Environment
Copy backend/.env.example to backend/.env and fill in:
JWT_SECRET— shared secret with platform-serviceCOSMOS_ENDPOINT/COSMOS_KEY— Azure Cosmos DB credentials (or useDB_PROVIDER=memory)
Tests
cd backend && npm test # 18 tests (10 files)
cd web && npm test # 6 tests (5 files)
Docs
AGENTS.md— AI agent onboarding guidedocs/PRD.md— Product requirementsdocs/ROADMAP.md— Master execution tracker