learning_ai_notes/README.md
2026-03-22 15:50:54 -07:00

1.6 KiB

NoteLett

Structured notes platform for humans and AI agents — part of the ByteLyst ecosystem.

Quick Start

pnpm install

# Backend (port 4016)
pnpm --filter @notelett/backend run dev

# Web (port 3000)
pnpm --filter @notelett/web run dev

# Mobile
pnpm --filter @notelett/mobile run 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-service
  • COSMOS_ENDPOINT / COSMOS_KEY — Azure Cosmos DB credentials (or use DB_PROVIDER=memory)

Tests

pnpm --filter @notelett/backend run test
pnpm --filter @notelett/web run test
pnpm --filter @notelett/mobile run test
pnpm run verify

Docs