docs: initial set - README, PLAN, UI-SPEC, RANKING

This commit is contained in:
AlexanderRozhenko
2026-11-10 17:38:01 -04:00
commit fc3aad1e93
4 changed files with 174 additions and 0 deletions

38
README.md Normal file
View File

@@ -0,0 +1,38 @@
# Bike-Tinder
A private, Tinder-style web app for browsing the motorcycle market: swipe real listings (like / nope / maybe), see everything on one editable list, and let the deck learn your taste. Built for Glenn; runs on the Rotarran, published to the tailnet only.
**Status:** v0.1 — design phase. No code yet; this repo currently holds the design docs. Build begins once the docs are approved.
## How it works
```
[single-source crawler] → [nightly importer] → [app DB] → [API + PWA deck] → Glenn's thumb
↓
[swipe history] → [ranking]
```
- **Crawl** — one marketplace source (chosen for scrape-simplicity; see `docs/SOURCES.md`) is fetched nightly by a pure script. No LLM involved, zero token cost.
- **Import** — the importer upserts the source's catalog into the app database: new listings appear, changes update, vanished listings retire after repeated misses (never a blocked page, never a guess).
- **Deck** — a Tinder-like PWA: card stack, drag to swipe, big buttons. Like / Nope / Maybe. "It's a match" moment when you like something.
- **List & edit** — every entry in one table; re-file any call later (a nope can become a like).
- **Ranking** — cold start uses the hunt's rubric score; after ~20–30 swipes a small, explainable model orders the deck by *your* taste (retrained nightly). "Because you liked X" chips, never a black box.
## Docs
- [`docs/SOURCES.md`](docs/SOURCES.md) — the v1 source decision (candidates, evidence, choice)
- [`docs/DESIGN.md`](docs/DESIGN.md) — architecture, components, data flow, deployment
- [`docs/DATA-MODEL.md`](docs/DATA-MODEL.md) — database schema + sync semantics
- [`docs/RANKING.md`](docs/RANKING.md) — cold-start + learned ranking design
- [`docs/UI-SPEC.md`](docs/UI-SPEC.md) — screens, gestures, Tinder-fidelity goals
- [`docs/PLAN.md`](docs/PLAN.md) — phases, acceptance criteria, status
## Deployment (planned)
A small podman compose stack on the Rotarran under `/var/mnt/DATA/podman-stacks/bike-tinder/`, its own systemd user unit (`Delegate=yes`), SQLite database, published to the tailnet only via `tailscale serve` on port 9453. Single user; no auth beyond the tailnet.
## Crew
- **Glenn** — owner; the thumb that swipes.
- **Alex** — resident agent; architecture, orchestration, docs.
- **Torres** — engineer; builds and maintains this repo.