No description
Find a file
Elijah c595e0ff2c
All checks were successful
Verify and publish V2 container / build-and-push (push) Successful in 1m0s
Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions
- Built-in Parallel web search (keyless; optional sign-in for higher limits and research)
  with its own settings page; OAuth sign-in (RFC 9728/8414/7591, PKCE, RFC 8707) for any
  MCP server, with token refresh and pre-registered client support
- Friendly tool steps (icon, name, status; details on click) and ids stripped from results;
  per-chat tool switches; taller thinking box
- Exams within classes: exam tabs, scoped lists, uploads, imports and Generate; exam-only
  material for generation; class setting for what the groups are called
- Assistant can ask clarifying questions in an inline form before generating
- OpenUI blocks (charts, questions, flashcards, inputs) in assistant, Explain and share chats
- Explain beside the quiz on wide screens, grounded in the cited source pages
- Quiz results: percentage ring coloured by score band, rainbow at 100
- Share links: assistant button like the owner's, hidden during quizzes; documents readable
  in the browser
- Live draft and library updates over server-sent events

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:30:00 -07:00
.forgejo/workflows Add V2 Forgejo workflow publishing study:v2 image 2026-11-12 11:29:22 -07:00
docs Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
scripts Second revision: MCP servers, shared-link AI, flashcard modes, document previews 2026-11-15 15:48:54 -07:00
server Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
shared Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
tests Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
web Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
.dockerignore Second revision: MCP servers, shared-link AI, flashcard modes, document previews 2026-11-15 15:48:54 -07:00
.env.example First revision: DeepSeek, numeric questions, background assistant, UI fixes 2026-11-15 12:48:17 -07:00
.gitattributes Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00
.gitignore Second revision: MCP servers, shared-link AI, flashcard modes, document previews 2026-11-15 15:48:54 -07:00
compose.yaml Harden private media and backup recovery; add V2 deployment and migration guides 2026-11-11 19:31:32 -07:00
Dockerfile Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
package-lock.json Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
package.json Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
PROGRESS.md Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
README.md Third revision: web search, MCP sign-in, exams, intelligent UI, clarifying questions 2026-11-15 20:30:00 -07:00
tsconfig.base.json Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00
tsconfig.json Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00
tsconfig.server.json Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00
tsconfig.web.json Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00
vite.config.ts Add the V2 web app: design system, shell, study flows, AI, settings, sharing 2026-11-11 08:53:01 -07:00
vitest.config.ts Start Study Desk V2: remove V1 sources, add backend foundation 2026-11-11 08:16:41 -07:00

Study Desk V2

A personal study platform for nursing school: classes and folders, quizzes, FSRS flashcards, notes, private documents, and AI-assisted content creation. One administrator; friends study through revocable public links without accounts.

Run locally

Requires Node.js 24 or newer and npm. The development VM currently uses Node 26.

npm.cmd ci
npm.cmd run dev

Open the Vite address printed in the terminal (normally http://localhost:5173). The API listens on port 3726. For the production build locally:

npm.cmd run build
npm.cmd start

Open http://localhost:3726. On a fresh install, enter the setup code from the server log or data/setup-code.txt, then choose your administrator password. Alternatively set ADMIN_PASSWORD for first startup. An optional .env file is loaded by the server; see .env.example. Existing environment variables take precedence.

This checkout already has an ignored .env pointing at .data/ from development. Do not delete it or run reset/seed commands against content you want to keep. The demo seeder is an opt-in development tool, never part of startup.

What is implemented

  • Classes divided into exams (or units, modules…), each with its own documents, quizzes and flashcards; generating for an exam uses only its material.
  • Search, edit/duplicate/move/delete actions; Markdown and embedded images.
  • Multiple-choice, select-all and numeric (type-the-answer calculation) questions; a start screen that hides answers, practice feedback, optional exam time limits, shuffle, partial credit, saved sessions, missed-question review, 7-point letter grades and history.
  • Flashcard editing, browse/self-assessment sessions, FSRS scheduling, persistent reviews, undo, keyboard shortcuts and streak effects.
  • Public quiz/deck/class/folder/note/document links. Collection (class and folder) shares include current and future quizzes, decks, notes and processed documents. Each link can allow "Explain this" and a chat about the shared material, separately (off by default).
  • Flashcards in Standard mode (know it / still learning, optionally repeating missed cards until known) or spaced repetition.
  • JSON import previews, validation, templates, content exports and a V1 SQLite import path.
  • PDF/DOCX/PPTX/TXT/Markdown/image uploads; text extraction, OCR via a configured vision model, chunking and SQLite FTS retrieval with source references. The original is shown next to the extracted text (Word and PowerPoint as a generated preview).
  • OpenAI, Anthropic, Gemini, DeepSeek, OpenAI-compatible and Ollama provider connections, manual/discovered models, task routing with reasoning effort from Off to Max, encrypted keys and usage estimates that price cached input separately.
  • Semantic search with cloud embeddings or a built-in model that runs on the server.
  • AI generation with editable drafts and editable instructions/presets; generation and assistant answers keep running on the server when you leave the page. The assistant searches materials, reads notes, creates drafts, finds weak topics, proposes confirmed content changes, accepts tagged or dragged-in materials, can switch models per chat and can show its reasoning. It runs Python in a sandbox, and generated quizzes are checked with it.
  • Built-in web search (Parallel; no account needed, optional sign-in for higher limits).
  • Interactive charts, practice questions and other blocks inline in assistant replies, and clarifying questions before the assistant generates.
  • MCP servers (Streamable HTTP, with OAuth sign-in) as extra assistant tools, each with your own instructions and switches for chat, explanations, generation and the quiz check.
  • Responsive light/dark interface and an installable app shell. Offline studying is limited: private data is not cached; most operations need a server connection.

Deploy, back up, migrate

See deployment and restore, V1 migration, and AI providers and account integration.

The image runs a single Node process with SQLite and local file storage. No database or queue container is required. The container runs as UID/GID 1000 and persists everything under /data.

docker compose up -d --build

Default V2 host port: 3727, deliberately separate from the old application. Use a separate data folder. Docker Desktop image build and disposable-container runtime checks now pass; Unraid-specific permissions and reverse-proxy checks remain. No production deployment has been performed.

Verification and resuming work

npm.cmd run check

Tests create isolated temporary databases. AI integration tests use a local mock server and need loopback networking. They do not spend provider credits. Real provider credentials, account-specific model access, Linux container behavior and Unraid proxy configuration must be checked in their target environments.

PROGRESS.md records completed work, remaining verification, decisions and the resume procedure. V1 remains on main and in Git history; V2 work is on the v2 branch. Pushing v2 to Forgejo runs CI and publishes the study:v2 image (never :latest); see deployment. Nothing deploys automatically.