32019c89f5
- CHANGELOG.md:新增 v1.6.0 条目,完整记录 15 项前端设计审查修复 - CLAUDE.md:新增 CSS Variables First / 避免 !important 代码规范、scan-root-styles.ts 桶文件说明、Quality Gate 增加硬编码颜色检查 - README.md / README_ZH.md:产品状态补充前端设计系统重构摘要 - docs/TECH_DEBT_ZH.md:标记前端工程债务已关闭、更新债务比例 95%→97%、版本号 v1.5.4→v1.6.0
154 lines
8.2 KiB
Markdown
154 lines
8.2 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
PolyWeather Pro — a production weather-intelligence stack for temperature settlement markets. Aggregates observations and forecasts for 52 monitored cities globally, blends multi-model highs using DEB (Dynamic Error Balancing), generates calibrated probability buckets for settlement, maps weather to Polymarket quotes for mispricing scans, and serves both a Next.js dashboard (Vercel) and a Telegram bot.
|
|
|
|
## Environment & Preferences (ALWAYS follow)
|
|
|
|
### Working Directory
|
|
- All commands run from the repo root: `E:/web/PolyWeather`
|
|
- Frontend dev server: `cd frontend && npm run dev` → http://localhost:3000
|
|
- Backend API server: `uvicorn web.app:app --reload --host 0.0.0.0 --port 8000` → http://localhost:8000
|
|
- When I say "start the server", assume the correct working directory is `E:/web/PolyWeather`
|
|
|
|
### Git Conventions
|
|
- **Commit language: Chinese (简体中文) ONLY**
|
|
- Format: Lore Commit Protocol — intent line in Chinese, trailers in English
|
|
- Examples: `重构城市决策卡 hero 布局` or `统一 DEB 数据源为单一计算路径`
|
|
- **NEVER** use English for commit subject lines
|
|
|
|
### Tooling
|
|
- Package manager: **npm** (not yarn/pnpm)
|
|
- Python: `python` (not python3), venv at `venv/`
|
|
- Lint: `ruff check .` (Python) + `npx tsc --noEmit` (TypeScript)
|
|
- NEVER ask me about these preferences again — commit to memory
|
|
|
|
## Architecture
|
|
|
|
```
|
|
Users (Web / Telegram) → Next.js Frontend (Vercel) → FastAPI /web/app.py
|
|
↓
|
|
Weather Collector (METAR, TAF, Open-Meteo, country networks)
|
|
↓
|
|
Analysis (DEB + Trend + Probability + Market Scan)
|
|
↓
|
|
Payment Layer (Intent + Event + Confirm Loop)
|
|
```
|
|
|
|
- **Backend**: FastAPI on port 8000 (`web/app.py` → `web/core.py` + `web/routes.py` + `web/analysis_service.py`)
|
|
- **Frontend**: Next.js 15 + React 19 + TypeScript + Tailwind CSS 3 on port 3000 (dev)
|
|
- **Bot**: Telegram bot via `bot_listener.py` → `src/bot/`
|
|
- **Shared analysis core** in `src/` is used by both web API and bot
|
|
- **Scan Terminal**: Real-time city opportunity scanning (`web/scan_terminal_service.py` and `frontend/components/dashboard/scan-terminal/`)
|
|
- **Dashboard**: Main dashboard with interactive map, city sidebar, detail panels, and probability views
|
|
|
|
## Commands
|
|
|
|
### Frontend (dev on port 3000)
|
|
```bash
|
|
cd frontend
|
|
npm ci
|
|
npm run dev # Next.js dev server
|
|
npm run build # Production build
|
|
npm run lint # ESLint via next lint
|
|
```
|
|
|
|
### Backend (dev on port 8000)
|
|
```bash
|
|
uvicorn web.app:app --reload --host 0.0.0.0 --port 8000
|
|
```
|
|
|
|
### Telegram Bot
|
|
```bash
|
|
python bot_listener.py
|
|
# or via wrapper:
|
|
python run.py
|
|
```
|
|
|
|
### Docker (production-like stack)
|
|
```bash
|
|
docker compose up -d --build # bot + web API
|
|
docker compose --profile workers up -d # + prewarm worker
|
|
docker compose --profile monitoring up -d # + Prometheus/Grafana/Alertmanager
|
|
```
|
|
|
|
### Python tests
|
|
```bash
|
|
pytest tests/ # all tests
|
|
pytest tests/test_web_observability.py # single test file
|
|
```
|
|
|
|
### Lint & Format
|
|
```bash
|
|
ruff check . # Python lint (pycodestyle + Pyflakes, line-length 88)
|
|
ruff format . # Python format (Black-compatible, double quotes)
|
|
```
|
|
|
|
### Health & Ops checks
|
|
```bash
|
|
curl http://127.0.0.1:8000/healthz
|
|
curl http://127.0.0.1:8000/api/system/status
|
|
curl http://127.0.0.1:8000/metrics
|
|
```
|
|
|
|
## Key Directories
|
|
|
|
| Directory | Purpose |
|
|
|-----------|---------|
|
|
| `src/data_collection/` | Weather sources (METAR, TAF, Open-Meteo, JMA, KMA, MGM, NMC, Russia stations, settlement sources), city registry (52 cities), Polymarket readonly layer |
|
|
| `src/analysis/` | DEB algorithm, trend engine, probability calibration (EMOS/LGBM), market alert engine, settlement rounding |
|
|
| `src/models/` | LightGBM daily-high model training and feature engineering |
|
|
| `src/payments/` | Onchain checkout, event listener, confirm loop, contract audit |
|
|
| `src/bot/` | Telegram bot handlers and orchestrator |
|
|
| `src/database/` | SQLite-based runtime state, DB manager, daily/truth/training feature repositories |
|
|
| `web/` | FastAPI app, routes (~65K), analysis service (~130K), scan terminal service (~56K), AI scan modules |
|
|
| `frontend/app/` | Next.js App Router pages (dashboard, account, auth, docs, ops, probabilities, scan) |
|
|
| `frontend/components/dashboard/` | Dashboard UI components (map, sidebar, detail panel, modals, charts, scan terminal). `scan-root-styles.ts` is the CSS Module barrel, combining 22 module roots into one pre-composed className |
|
|
| `frontend/lib/` | Shared client logic: types, API client, chart utils, i18n, dashboard utils |
|
|
| `frontend/hooks/` | React hooks: dashboard store (global state), Leaflet map, chart helper |
|
|
| `scripts/` | Operational scripts: probability calibration training, backfills, payment reconciliation, prewarm worker |
|
|
| `config/` | YAML config (city list, weather settings, logging) |
|
|
| `docs/` | Bilingual product & technical docs |
|
|
| `monitoring/` | Prometheus/Grafana/Alertmanager configs |
|
|
|
|
## Key Technical Details
|
|
|
|
- **Python version**: 3.11 (target), type hints use `from __future__ import annotations` in most modules
|
|
- **Package manager**: pip (requirements.txt) + uv cache is present but not the primary tool; no pyproject.toml build system defined
|
|
- **Frontend package manager**: npm
|
|
- **State storage**: SQLite primary path (set via `POLYWEATHER_STATE_STORAGE_MODE=sqlite` + `POLYWEATHER_DB_PATH`). Legacy JSON/JSONL files are migration/fallback only.
|
|
- **Runtime data**: External dir recommended (`POLYWEATHER_RUNTIME_DATA_DIR=/var/lib/polyweather`) to avoid git conflicts
|
|
- **Auth gating** (frontend middleware): Token-based (`POLYWEATHER_DASHBOARD_ACCESS_TOKEN`) or Supabase session-based (`POLYWEATHER_AUTH_ENABLED`). Local dev hosts bypass auth.
|
|
- **CORS**: Allowed origins from `WEB_CORS_ORIGINS` env var (defaults: localhost:3000, polyweather-pro.vercel.app)
|
|
- **EMOS/CRPS calibration**: Trainable but production should use `legacy` or `emos_shadow` engine; `emos_primary` only after local evaluation + manual rollout
|
|
- **API proxy**: Frontend uses Next.js rewrites to proxy `/api/*` to the FastAPI backend; see `frontend/lib/api-proxy.ts` and `frontend/lib/backend-api.ts`
|
|
|
|
## Commit Convention
|
|
|
|
This repo uses the **Lore Commit Protocol** — structured decision records with git trailers (`Constraint:`, `Rejected:`, `Confidence:`, `Scope-risk:`, `Directive:`, `Tested:`, `Not-tested:`). Intent line first (why, not what).
|
|
|
|
- Always write git commit messages in **Chinese (简体中文)**.
|
|
|
|
## Code Style
|
|
|
|
- Never use Unicode escape sequences (`\uXXXX`) in source code; write characters directly in UTF-8 encoding.
|
|
- When modifying UI components, update both **dark-mode and light-mode CSS files** in the same edit batch.
|
|
- **CSS Variables First**: Prefer `var(--color-*)` / `var(--color-signal-*)` tokens over hardcoded hex values. The token system is defined in `globals.css` with light-theme overrides under `html.light`.
|
|
- **Avoid `!important`**: Only use it for Leaflet map overrides (inline style conflict) and chart canvas sizing. For light-theme overrides, use `html.light .root` prefix for higher specificity.
|
|
- **New CSS Modules**: Add the module root class to `scan-root-styles.ts` barrel file instead of importing it separately in `ScanTerminalDashboard.tsx`.
|
|
|
|
## Quality Gates (MANDATORY)
|
|
|
|
Before marking any task as complete, you MUST:
|
|
|
|
1. **Type check** — Run `npx tsc --noEmit` (frontend) or `python -m ruff check .` (backend) on modified files
|
|
2. **No Unicode escapes** — Verify that NO `\uXXXX` sequences were introduced; if found, revert and fix
|
|
3. **Dual-theme CSS** — For any UI change, confirm BOTH the dark CSS module AND `ScanTerminalLightTheme.module.css` were updated
|
|
4. **No new hardcoded palette colors** — Use `var(--color-*)` token references instead of `#4DA3FF` / `#E6EDF3` / `#9FB2C7` / `#6B7A90` hex values
|
|
5. **Show the diff** — Output `git diff --stat` and test results before declaring success
|
|
|
|
If any gate fails, fix it BEFORE reporting success.
|