feat: add Dockerfile, .dockerignore, and README; remove common crate

Co-authored-by: Copilot <copilot@github.com>
2026-05-04 15:19:29 +02:00
parent 6dcc4c8317
commit 5dd9aac68d
10 changed files with 175 additions and 21 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,86 @@
+# Movies Diary
+
+A self-hosted, server-side rendered movie logging system. Built in Rust — no JavaScript, no SPA, just HTML forms and an RSS feed. Designed to run as a lightweight widget embedded on a personal site.
+
+## Features
+
+- Log movies with a TMDB/OMDb ID and a 0–5 rating
+- Immutable append-only viewing ledger (tracks re-watches)
+- Background poster fetching and storage (S3-compatible)
+- RSS/Atom feed for public subscription
+- JWT authentication via cookie (HTML) or Bearer token (REST API)
+- Zero JavaScript
+
+## Architecture
+
+Hexagonal (Ports & Adapters) with Domain-Driven Design:
+
+```
+domain        — pure types and trait definitions, no external deps
+common        — shared error types
+application   — use cases / business logic orchestration
+presentation  — Axum HTTP router, wires all adapters together
+adapters/
+  auth        — JWT issuance and validation (Argon2 passwords)
+  sqlite      — SQLite repository via sqlx
+  metadata    — OMDb HTTP client
+  poster-fetcher — downloads poster images
+  poster-storage — uploads posters to S3-compatible storage
+  template-askama — Askama HTML rendering
+  rss         — RSS/Atom feed generation
+  event-publisher — async event channel for background poster sync
+```
+
+## Prerequisites
+
+- Rust (stable, 2024 edition)
+- SQLite
+- An S3-compatible object store (e.g. MinIO) for poster storage
+- An [OMDb API key](https://www.omdbapi.com/apikey.aspx)
+
+## Environment Variables
+
+Copy and fill in the following (e.g. in a `.env` file):
+
+```env
+# Database
+DATABASE_URL=sqlite://movies.db
+
+# Authentication
+JWT_SECRET=change-me
+JWT_TTL_SECONDS=86400
+
+# OMDb metadata
+OMDB_API_KEY=your-key
+
+# Poster storage (S3-compatible)
+MINIO_ENDPOINT=http://localhost:9000
+MINIO_BUCKET=posters
+MINIO_REGION=us-east-1
+MINIO_ACCESS_KEY_ID=minioadmin
+MINIO_SECRET_ACCESS_KEY=minioadmin
+
+# Optional
+ALLOW_REGISTRATION=false
+POSTER_FETCH_TIMEOUT_SECONDS=10
+EVENT_CHANNEL_BUFFER=32
+RUST_LOG=presentation=debug,tower_http=debug
+```
+
+## Run
+
+```bash
+cargo run -p presentation
+```
+
+Server listens on `0.0.0.0:3000`.
+
+## Test
+
+```bash
+cargo test
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE).