Study/README.md
Elijah 3046e46d1c Add V2 Forgejo workflow publishing study:v2 image
Pushes to v2 typecheck and test inside the Node 24 image via a new Dockerfile
test stage, build and smoke-test the production image as a fresh non-root
container, then publish :v2 and :v2-<sha>. Never touches V1's :latest.
Document the image tags and Unraid 99:100 volume ownership.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 11:29:22 -07:00

83 lines
3.8 KiB
Markdown

# 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.
```powershell
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:
```powershell
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](.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, folders, search, edit/duplicate/move/delete actions; Markdown and embedded images.
- Multiple-choice and select-all quizzes; practice feedback, exam timers, shuffle, partial
credit, saved sessions, missed-question review, results and history.
- Flashcard editing, browse/self-assessment sessions, FSRS scheduling, persistent reviews,
undo, keyboard shortcuts and streak effects.
- Public quiz/deck/class/folder/note links and explicitly shared documents. Collection shares
include current and future quizzes, decks and notes; uploaded documents stay private.
- 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.
- OpenAI, Anthropic, Gemini, OpenAI-compatible and Ollama provider connections, manual/discovered
models, task routing, encrypted keys and usage estimates.
- AI generation with editable drafts; an assistant that searches materials, reads notes,
creates drafts, finds weak topics and proposes confirmed content changes.
- 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](docs/DEPLOYMENT.md), [V1 migration](docs/MIGRATION.md), and
[AI providers and account integration](docs/AI.md).
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`.
```sh
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
```powershell
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](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](docs/DEPLOYMENT.md). Nothing deploys automatically.