Files
fin-tracker/docs/ai/README.md
T
Dmitry 989a780f9f docs: зафиксировать визуальный язык клиента в design-system.md
Описывает токены темы, SectionHeader/TileCarousel, NavSidebar и
осознанные побочные эффекты (dataQualityProvider/meProvider watch из
шелла), а также что ещё не редизайнено — health_page.dart и карточки
holdings_tab.dart/goal_card.dart.
2026-09-19 15:32:00 +03:00

42 lines
2.7 KiB
Markdown

# docs/ai — обзор проекта
## Назначение
`fin-tracker` объединяет два мира личных финансов:
- **ZenMoney** — повседневные счета и транзакции (синкается с банками сам), читаем через
`POST /v8/diff/`;
- **брокеры** — T-Invest по gRPC API, Сбер и ВТБ через загрузку отчётов, прочее вручную/CSV;
и считает поверх них то, за что раньше платили Snowball Income: позиции по всем брокерам,
P&L, XIRR/TWR, аллокацию, календарь дивидендов и купонов с прогнозом, ребалансировку,
бенчмарки, налоги — плюс net worth, cash flow и runway по ZenMoney.
## Система в общих чертах
```
sources/* ──sync──▶ raw_* (JSONB, идемпотентно) ──map──▶ core (account, instrument, event, cash_txn…)
worker (APScheduler, advisory locks) ▼
ledger (лоты FIFO, дедуп, матчинг ZM↔брокер)
analytics (polars, pyxirr) ──▶ metric_* ──▶ api ──▶ Flutter
```
- `backend/src/fintracker/sources/` — по одному пакету на источник, контракт в `base.py`.
- `worker/` — планировщик и запуск синков (`runner.run_source`): lock, `sync_run`, курсор.
- `api/` — FastAPI, `/api/v1`, ошибки RFC 7807, деньги строками.
- `app/` — Flutter, клиент сгенерирован из `openapi/openapi.json`.
## Документы
- [architecture.md](architecture.md) — домен, модули, потоки данных, API.
- [conventions.md](conventions.md) — деньги, валюты, идемпотентность, стиль.
- [plan.md](plan.md) — фазы и чек-листы проверки.
- [ops.md](ops.md) — деплой на VPS, бэкапы, секреты.
- [links.md](links.md) — внешние API и референсы.
- [offline-cache.md](offline-cache.md) — офлайн-кэш Flutter-клиента: контракт `Cached<T>`,
`CacheInterceptor`, баннер «данные на …» (фаза 5).
- [design-system.md](design-system.md) — визуальный язык Flutter-клиента: токены темы,
`SectionHeader`/`TileCarousel`, группированный `NavSidebar` (обкатано на Обзоре).