Giorgio Gilestro
824d849c63
The product is now "Read the Markets" served at https://read.markets, with the app at https://app.read.markets. "Cassandra" survives only as the in-product AI persona (system prompt + "Ask Cassandra" chat label). Centralised the brand in app/branding.py: BRAND_NAME, BRAND_SHORT, DOMAIN, SITE_URL, APP_URL, EMAIL_FROM_DEFAULT. Jinja templates pull {{ BRAND_NAME }} via globals registered in templates_env.py; Python code reads branding.BRAND_NAME directly. The future-rename surface is now a one-liner. Updated: FastAPI app title, every page title (dashboard, news, log, settings, upload, login, verify), header brand div, auth-card brands, OTP email subject + HTML + plain-text bodies (incl. uppercase header tag), OpenRouter X-Title + HTTP-Referer attribution headers, README. Email tests now assert against branding.BRAND_NAME rather than the literal string. Internal identifiers deliberately kept on the legacy "cassandra" name to avoid invalidating live sessions / advisory locks / configs: cookies (cassandra_session, cassandra_pending) + itsdangerous salts, MariaDB GET_LOCK keys, CASSANDRA_TOKEN env var, cassandra.css filename, pyproject package name, localStorage prefs, outbound User-Agent strings. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
# Read the Markets
|
|
|
|
Containerised macro-strategy dashboard — hourly market data, RSS news, Trading 212 portfolio, and an AI-generated strategic log written by **Cassandra**, the in-product seer. Read-only by design.
|
|
|
|
Production:
|
|
- Landing: <https://read.markets>
|
|
- App: <https://app.read.markets>
|
|
|
|
The Python package is still named `cassandra` and several internal identifiers (cookie names, advisory-lock keys, `CASSANDRA_TOKEN` env var, CSS filename) keep the legacy name on purpose — renaming them would invalidate live sessions / locks / configs for no user benefit. See `app/branding.py` for the brand single-source-of-truth.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
cp .env.example .env # fill in API keys; set CASSANDRA_TOKEN if exposing
|
|
docker compose up --build # db + app + scheduler + daily backup sidecar
|
|
open http://localhost:8000/
|
|
```
|
|
|
|
## Architecture
|
|
|
|
- **app** (FastAPI + Jinja2 + HTMX) — web dashboard on port 8000
|
|
- **scheduler** (APScheduler) — hourly ingestion jobs (market, news, portfolio, AI log)
|
|
- **db** (MariaDB 11) — quotes, headlines, portfolio snapshots, strategic logs, job runs
|
|
- **backup** (sidecar) — daily mariadb-dump to `./backup/`
|
|
|
|
See `/home/gg/.claude/plans/ok-i-think-this-tidy-lake.md` for the design plan.
|
|
|
|
## Config
|
|
|
|
| File | Purpose |
|
|
|---|---|
|
|
| `config/default.toml` | Universal data tables: indicator groups, RSS feeds, keyword presets |
|
|
| `config/portfolio.toml` | User-specific portfolios (overrides `default.toml`) |
|
|
| `.env` | Secrets and runtime knobs — mounted read-only into containers |
|
|
|
|
## Endpoints
|
|
|
|
- `GET /` — dashboard
|
|
- `GET /portfolio/{name}` — portfolio detail
|
|
- `GET /news` — news feed
|
|
- `GET /log` — strategic-log archive
|
|
- `GET /api/health` — job status (last success / failure per job)
|
|
|
|
All authenticated routes require `Authorization: Bearer $CASSANDRA_TOKEN` if the env is set; if unset, the app is open (LAN-only mode).
|