How potlakai/nus-desktop works
Nūs Desktop is a local-first semester organizer: students import course material, review AI-proposed work, and manage tasks and deadlines from a local database. Its Electron main process coordinates the dashboard, AI and integrations; a persistent Companion overlay adds voice and guided, screen-aware help. The README also documents account plans, Stripe billing, and anonymous usage metrics. Edges follow shown imports/calls or README-described behavior; several feature implementations were not sampled, so uncertain wiring is omitted.
Main entry points: main.js Desktop runtime · index.js Companion runtime · session.js Guide session · app.js Dashboard UI
Components 28
Desktop organizer
- Dashboard UI
renderer/app.js - Desktop runtime
src/main.js - Semester database
src/db.js - Syllabus and AI
src/ai.js - Task planning
src/logic.js - Smart tasks
src/smart.js - Email drafts
src/draft.js - Local transcription
src/stt-local.js
Companion overlay
- Companion runtime
companion/index.js - Knot interface
companion/renderer/renderer.js - Companion settings
companion/src/store.js - Companion speech
companion/src/stt.js - Companion AI
companion/src/llm.js - Guide session
companion/src/guide/session.js - Target selection
companion/src/guide/pointing.js - Target verification
companion/src/guide/verify.js - Windows UI probe
companion/src/win/probe.js
External integrations
- Google Calendar
src/gcal.js - Outlook inbox
src/outlook.js
Account and metrics
- Plan limits
src/limits.js - Account auth
src/auth.js - Usage metrics
src/stats.js - Checkout endpoint
supabase/functions/create-checkout/index.ts
Other components
- Student
- Stripe
- Supabase
- Anthropic Claude
- Google Gemini
Connections 28
- Student → Dashboard UI: uses
- Dashboard UI → Desktop runtime: requests actions
- Desktop runtime → Semester database: reads and writes
src/main.js - Desktop runtime → Syllabus and AI: extracts syllabus
src/main.js - Desktop runtime → Task planning: decomposes tasks
src/main.js - Desktop runtime → Smart tasks: uses
src/main.js - Desktop runtime → Google Calendar: uses
src/main.js - Desktop runtime → Outlook inbox: uses
src/main.js - Desktop runtime → Email drafts: uses
src/main.js - Desktop runtime → Local transcription: transcribes locally
src/main.js - Student → Knot interface: asks or speaks
- Desktop runtime → Companion runtime: hosts overlay
src/main.js - Companion runtime → Knot interface: sends UI events
- Companion runtime → Companion settings: reads settings
companion/index.js - Companion runtime → Companion speech: transcribes audio
companion/index.js - Companion runtime → Companion AI: requests answers
companion/index.js - Companion runtime → Guide session: starts guides
companion/index.js - Guide session → Target selection: selects target
companion/src/guide/session.js - Guide session → Target verification: validates target
companion/src/guide/session.js - Guide session → Windows UI probe: queries controls
companion/src/guide/session.js - Companion AI → Google Gemini: calls provider
- Desktop runtime → Anthropic Claude: calls provider
- Desktop runtime → Plan limits: checks caps
src/main.js - Desktop runtime → Account auth: checks account
src/main.js - Account auth → Supabase: authenticates
src/auth.js - Desktop runtime → Usage metrics: records usage
src/main.js - Desktop runtime → Checkout endpoint: starts Pro checkout
- Checkout endpoint → Stripe: creates checkout
supabase/functions/create-checkout/index.ts