Skip to content

allandng/Chalkmark

Repository files navigation

Chalkmark

Chalkmark is a study app using local LLMs to boost productivity!

Quick start

# Frontend (plain browser, mock backend)
npm --prefix src run dev          # http://localhost:1420

# Full desktop app with real Rust IPC
cargo tauri dev

# Generate icon set from the master logo
pwsh scripts/build-icons.ps1

Next contributor: start with needs-to-wire.md — it inventories which UI panels still read from MOCK_DATA vs which call real Rust IPC, plus the backend pieces blocking each unwired flow.

The historical build-phase plans (logo + frontend port + Tauri wiring + QA) are archived in docs/phases/ — see docs/phases/PHASES.md for the index. Frontend types and IPC client are in src/src/; Rust handlers are in src-tauri/src/commands/; shared core is in core/src/.

TODOs

  • Replace placeholder app icon at src-tauri/icons/icon.ico. Done — chalkboard-and-book logo at assets/source/chalkmark-logo.png; regenerate icons with pwsh scripts/build-icons.ps1 (multi-res icon.ico, icon.icns, three PNG sizes + in-app favicon src/public/logo.png).
  • Re-evaluate sqlite-vec version — currently pinned to =0.1.6 in core/Cargo.toml because the latest 0.1.10-alpha.3 ships a sqlite-vec.c that #includes sqlite-vec-diskann.c (not packaged in the crate), causing MSVC fatal error C1083 on Windows. Re-evaluate when upstream releases a non-alpha with the DiskANN feature properly gated.
  • Replace the frontend stub at src/index.html Done — full React + TypeScript port of the design bundle (three-pane shell, chalk / blackboard / white themes, Sidebar / CenterPane with 7 tabs / ConversationPane with branching, CourseHome, Quiz, Flashcards, 5 modals, uploads infra). See PHASES.md for the per-phase breakdown.

About

Chalkmark is a study app using local LLMs to boost productivity!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors