freezmo/.env.example
Martin Dvorak e4a8e0ba01 Phase 2: learning engine — history, SRS review, mistakes, stats, exam, reminders
Answer history and schedules
- Every answer is recorded (deck, activity, topic, correct/wrong, time)
  in a versioned IndexedDB log (freezmo-learning v1, stores answers +
  srs), mirrored in memory for synchronous React reads and capped at
  20k answers (oldest pruned). StudyFeed records as it grades.
- Light SM-2 schedule per activity: 1 day, 3 days, then interval x
  ease; wrong answers return in ten minutes with the ease nudged down.

Review, mistakes, stats
- Library 'Smart review' card: due count, mistakes count (latest
  answer wrong — clears itself when answered correctly), today's goal
  progress. Review sessions freeze their item list at start.
- New /review (due across decks, ?mistakes=1 global or ?deck= per
  deck) built on a shared SessionFeed with the study feed's snap/keyboard
  mechanics, wake lock and a results slide.
- New /stats: day streak, five-week calendar, accuracy per subject and
  per deck, weakest topics (>=3 answers), daily-goal progress.
- Daily goal configurable in Settings (10/20/30/50).

Exam mode
- New /exam: pick decks, question count, optional timer; no hints
  (a NoHints context hides hint rows and the self-check escape);
  results with score, per-deck and per-topic breakdown; wrong answers
  land in the mistakes set through the normal history.

Reminders (conditional)
- VAPID-gated: GET/POST/DELETE /api/push and POST /api/push/test with
  the standard route pattern, RATE_LIMIT_PUSH, zod, auth before body.
  Subscriptions stored server-side as endpoint + keys only (PUSH_DIR).
  UI hidden entirely without keys; iOS install note; service worker
  push/notificationclick handlers; scripts/send-reminders.mjs for a
  cron/systemd timer; web-push added as the one server dependency.

Verified: new phase-2 suite 42/42 (history/SRS shapes from a real study
run, mistakes clearing, review session, stats math, exam timer and
breakdowns, VAPID-less hidden state plus the configured
subscribe/validate/test/delete path against a second instance) plus
regression 74/74, mobile 52/52, wizard 80/80, declutter 116/116,
animation 8/8, native 35/35, phase1 38/38, i18n 25/25. Key parity
709/709. Lint + build clean. SW freezmo-v26.
2026-10-10 14:15:21 +00:00

78 lines
3.7 KiB
Bash

# ---------------------------------------------------------------------------
# Freezmo - Ollama configuration
# Copy this file to `.env.local` and adjust if needed.
# ---------------------------------------------------------------------------
# WHO PROVIDES THE API KEY -----------------------------------------------------
# user-key (default) Every browser supplies its own key. The key is typed
# into the settings dialog, kept in that browser's local
# storage and sent with each request in the
# `x-ollama-key` header. The server never stores it.
# Point OLLAMA_BASE_URL at https://ollama.com.
# server One key for everyone, read from OLLAMA_API_KEY below
# (single-user installs). Nothing is sent from the client.
# local No key at all: a local daemon signed in with
# `ollama signin` proxies the cloud models.
OLLAMA_AUTH=user-key
# Ollama endpoint. https://ollama.com for cloud, http://localhost:11434 for a
# local daemon. In user-key mode this is the endpoint the browser's key is sent
# to; in server/local mode it is used directly.
OLLAMA_BASE_URL=https://ollama.com
# Only used when OLLAMA_AUTH=server. Never commit a real key.
OLLAMA_API_KEY=
# Model used for the vision/transcription step (reads photos of notes).
# Must be multimodal — gpt-oss and other text-only models cannot be used here.
# Free-tier friendly: gemma4:31b-cloud, kimi-k3:cloud (paid), mistral-large-3 (paid).
VISION_MODEL=gemma4:31b-cloud
# Model used to generate activities, grade short answers and restore the
# language if a transcription came back translated. gpt-oss:120b is free-tier
# friendly, very good at strict JSON and the strongest multilingual model in the
# free plan. NOTE: it is text-only, so it can't be used as VISION_MODEL.
# Free alternatives: nemotron-3-super:cloud, gpt-oss:20b-cloud.
# Paid/credit: glm-5.3-flash:cloud, kimi-k3:cloud.
TEXT_MODEL=gpt-oss:120b-cloud
# RATE LIMITS (per client IP, sliding window, in-memory) ----------------------
# Generation decks are expensive, so they are limited tightly by default.
# RATE_LIMIT_WINDOW_MS=300000
# RATE_LIMIT_GENERATE=12
# RATE_LIMIT_GRADE=40
# RATE_LIMIT_HOMEWORK=12
# RATE_LIMIT_HEALTH=90
# Encrypted sync (no model calls, but shouldn't be hammered).
# RATE_LIMIT_SYNC=60
# Push subscription changes and test sends.
# RATE_LIMIT_PUSH=30
# PUSH REMINDERS (optional) ----------------------------------------------------
# Web Push reminders only appear in the UI when BOTH VAPID keys are set.
# Generate them once with: npx web-push generate-vapid-keys
# VAPID_PUBLIC_KEY=
# VAPID_PRIVATE_KEY=
# VAPID_SUBJECT=mailto:you@example.com
# Where subscriptions are stored (endpoint + keys only, no personal data).
# PUSH_DIR=.freezmo/push
# The daily sender is a script you schedule yourself (cron/systemd timer):
# node scripts/send-reminders.mjs
# PUSH_REMINDER_TITLE=Time to review
# PUSH_REMINDER_BODY=Your decks are waiting — a few due cards keep the streak alive.
# ENCRYPTED SYNC STORAGE -------------------------------------------------------
# Opt-in sync uploads an opaque AES-GCM blob; the server can't read it and
# never sees the passphrase or the API key. One small JSON file per sync ID.
# SYNC_DIR=.freezmo/sync
# Per-blob cap in bytes (larger uploads are refused with HTTP 413).
# SYNC_MAX_BYTES=12582912
# Total cap for the directory in bytes (new blobs refused with HTTP 507).
# SYNC_TOTAL_BYTES=1073741824
# Optional tuning ------------------------------------------------------------
# OLLAMA_TIMEOUT_MS=300000
# OLLAMA_HEALTH_TIMEOUT_MS=8000
# Send `think: false` to thinking models for faster JSON output.
# OLLAMA_THINK=false
# FREEZMO_DEFAULT_ACTIVITY_COUNT=10