Oliver/sandbox-notebookllamalm-nextjs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README for v3.1.0: theme system, new Studio features, API endpoints

Browse source 
- Document light/dark theme system and toggle
- Expand Slide Deck description: template generation, per-slide editing, diagrams
- Add mindmap/from-template/edit-slide API endpoints to reference
- Add note about JWT requirement on download endpoints
- Update frontend tech stack entry with CSS custom property system
- Bump version to 3.1.0, date March 15 2026

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Vadym Samoilenko 2026-03-15 00:10:16 +00:00
parent 04b3a96832
commit d1e5202454
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -107,10 +107,11 @@ docker compose exec backend /app/.venv/bin/python -c \
- **Flashcards** — 15-20 study cards with 3D flip animation
- **Quiz** — 10-12 multiple choice questions with scoring
- **Mind Map** — SVG radial tree visualization
- **Slide Deck** — 8-12 slide presentation with PPTX download
- **Slide Deck** — 8-12 slide presentation with PPTX download; slide diagrams (flowcharts, bar charts) rendered in preview and exported; supports custom .pptx template upload (Claude analyzes and rebuilds it) and per-slide AI editing without regenerating the full deck
- **Report** — executive summary + sections + conclusions with PDF download
- **Infographic** — visual blocks with stats and emojis
- **Data Table** — structured comparison table
- All Studio modules accept a **custom prompt** to guide content generation and style
### Chat
- **Real-time WebSocket Chat** — ask questions across all documents
@ -153,7 +154,7 @@ docker compose exec backend /app/.venv/bin/python -c \
### Tech Stack
**Frontend:** Next.js 15 (App Router), React 19, TypeScript, Tailwind CSS 4, React Query, Zustand, MSAL, WebSocket
**Frontend:** Next.js 15 (App Router), React 19, TypeScript, Tailwind CSS 4, React Query, Zustand, MSAL, WebSocket, CSS custom property theme system (light/dark)
**Backend:** FastAPI, SQLAlchemy, Python 3.13, uv package manager
@ -192,6 +193,9 @@ Full docs: `http://localhost:9000/docs`
- `POST /api/notebooks/{id}/studio/{type}` — generate (flashcards / quiz / mindmap / slides / report / infographic / datatable)
- `GET /api/notebooks/{id}/studio/slides/download` — PPTX file
- `GET /api/notebooks/{id}/studio/report/download` — PDF file
- `GET /api/notebooks/{id}/studio/mindmap/download` — SVG file
- `POST /api/notebooks/{id}/studio/slides/from-template` — generate PPTX from uploaded template (multipart)
- `POST /api/notebooks/{id}/studio/slides/edit/{index}` — regenerate single slide via prompt
**Documents:**
- `POST /api/documents/upload/{notebookId}` — upload file
@ -208,6 +212,8 @@ Full docs: `http://localhost:9000/docs`
- `POST /api/auth/login` — login
- `POST /api/auth/microsoft` — SSO login
> **Note:** All download endpoints require the JWT token via `Authorization: Bearer` header. The frontend uses `fetch()` with the auth header for all binary downloads.
---
## 🔐 Microsoft SSO Setup
@ -327,4 +333,14 @@ sandbox-notebookllamalm-nextjs/
---
**Version:** 3.0.0 | **Updated:** March 2026 | **Status:** Production
---
## 🎨 Theme System
All pages support **light and dark mode**. The toggle is in the top navigation bar (☀ / ☾).
The theme is built on CSS custom properties (`--bg`, `--fg`, `--primary`, `--border`, etc.) defined in `globals.css`. The selected theme is persisted to `localStorage` and applied before hydration to prevent flash.
---
**Version:** 3.1.0 | **Updated:** March 15, 2026 | **Status:** Production