GKaszewski/movies-diary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: mark TUI as deprecated experiment
Some checks failed
CI / Check / Test (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Gabriel Kaszewski
2026-06-09 00:02:20 +02:00
parent a7a11dde08
commit 6d238b6c3d
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -26,7 +26,7 @@ A self-hosted, server-side rendered movie logging system with a full REST API. B
- CSRF protection on all HTML form routes (double-submit cookie, defense-in-depth on top of `SameSite=Strict`) - CSRF protection on all HTML form routes (double-submit cookie, defense-in-depth on top of `SameSite=Strict`)
- Per-IP rate limiting via token bucket (production-grade, backed by `axum-governor`) - Per-IP rate limiting via token bucket (production-grade, backed by `axum-governor`)
- Single-page app at `/app/` — React + TanStack Router + shadcn/ui, built with Vite, served from the backend with client-side routing fallback - Single-page app at `/app/` — React + TanStack Router + shadcn/ui, built with Vite, served from the backend with client-side routing fallback
- Terminal UI client (`crates/tui`) for logging reviews, bulk CSV import, and diary browsing - Terminal UI client (`crates/tui`, deprecated) for logging reviews, bulk CSV import, and diary browsing
## Architecture ## Architecture
@@ -173,13 +173,15 @@ Set `CORS_ORIGINS=http://localhost:5173` in the backend `.env` to allow cross-or
For production, `npm run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically). For production, `npm run build` outputs to `spa/dist/` which the backend serves statically (included in Docker image automatically).
## Terminal UI ## Terminal UI (deprecated)
> **Note:** The TUI was an experiment with ratatui and is no longer actively maintained. It may not support newer features (goals, watchlist, federation, etc.). Contributions welcome — if you'd like to maintain it, open a PR.
```bash ```bash
cargo run -p tui cargo run -p tui
``` ```
Supports review logging, bulk CSV import (column order matches the export format), and diary browsing with review history. Supports review logging, bulk CSV import, and diary browsing.
## Development ## Development