How hades0050/noteboard-speek works
Noteboard combines notes, a kanban board, image/audio attachments, and background speech transcription. Users create and manage notes through the web UI and ConnectRPC; audio is uploaded separately over REST, queued for transcription, and the resulting text is stored with the note. The Go app wires transport adapters, use cases, persistence, and STT implementations. The README and sampled wiring establish the main architecture; some UI-to-board and RPC-handler details are represented only as documented or unverified relationships.
Main entry points: app.go Application wiring · transcribe.go Transcription worker · rpc ConnectRPC handlers · useNotes.ts Notes state
Components 26
Web app
- Notes and board UI
web/app/pages/index.vue - Note editor modal
web/app/components/NoteModal.vue - Audio recorder
web/app/composables/useRecorder.ts - Notes state
web/app/composables/useNotes.ts - RPC clients
web/app/composables/useRpc.ts - TypeScript API types
web/app/gen/noteboard/v1/noteboard_pb.ts
API adapters
- API contract
api/proto/noteboard/v1/noteboard.proto - Process entry
cmd/noteboard/main.go - Application wiring
internal/app/app.go - ConnectRPC handlers
internal/controller/rpc - Generated Connect handlers
internal/gen/noteboard/v1/noteboardv1connect/noteboard.connect.go - REST files and health
internal/controller/rest - Embedded web delivery
internal/webui/webui.go
Use cases
- Notes workflows
internal/usecase/notes.go - Board workflows
internal/usecase/board.go - Transcription worker
internal/usecase/transcribe.go - Domain entities
internal/entity
Persistence
- Notes repository
internal/repo/sqlite/notes.go - Board repository
internal/repo/sqlite/board.go - Transcription queue
internal/repo/sqlite/queue.go - SQLite database
internal/repo/sqlite - Audio and image files
internal/repo/blob/blob.go
Speech processing
- STT engine adapters
internal/stt - Audio conversion
internal/stt/ffmpeg.go
Other components
- User
- STT service
Connections 34
- User → Notes and board UI: uses
- Notes and board UI → Note editor modal: opens
- Notes and board UI → Notes state: loads notes
- Note editor modal → Audio recorder: records audio
- Note editor modal → Notes state: edits notes
- Notes state → RPC clients: calls
web/app/composables/useNotes.ts - RPC clients → API contract: uses contract
- RPC clients → ConnectRPC handlers: sends RPC
web/app/composables/useRpc.ts - Notes state → REST files and health: uploads audio
web/app/composables/useNotes.ts - Process entry → Application wiring: starts
cmd/noteboard/main.go - Application wiring → ConnectRPC handlers: mounts
internal/app/app.go - Application wiring → REST files and health: constructs
internal/app/app.go - Application wiring → Embedded web delivery: loads handler
internal/app/app.go - Generated Connect handlers → ConnectRPC handlers: dispatches handlers
- ConnectRPC handlers → Notes workflows: handles note calls
- ConnectRPC handlers → Board workflows: handles board calls
- REST files and health → Audio and image files: handles files
internal/controller/rest/router.go - Notes workflows → Notes repository: persists notes
- Board workflows → Board repository: persists board
- Transcription worker → Transcription queue: claims and finishes
internal/usecase/transcribe.go - Transcription worker → Audio conversion: converts audio
internal/usecase/transcribe.go - Transcription worker → STT engine adapters: transcribes
internal/usecase/transcribe.go - STT engine adapters → STT service: calls when configured
- Application wiring → Transcription worker: starts worker
internal/app/app.go - Application wiring → Notes repository: constructs repository
internal/app/app.go - Application wiring → Board repository: constructs repository
internal/app/app.go - Application wiring → Transcription queue: constructs repository
internal/app/app.go - Notes repository → SQLite database: reads and writes
- Board repository → SQLite database: reads and writes
internal/repo/sqlite/board.go - Transcription queue → SQLite database: stores queue
- Notes workflows → Domain entities: uses domain types
- Board workflows → Domain entities: uses domain types
- Transcription worker → Domain entities: processes notes
internal/usecase/transcribe.go - Application wiring → Audio and image files: constructs stores
internal/app/app.go