Compare commits
1 Commits
feature/ba
...
chore/bran
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d7fb5b71ef |
56
PLAN.md
56
PLAN.md
@@ -69,6 +69,8 @@ flowchart LR
|
||||
API -->|"DB_* connection"| DB
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 4.2 Вне рантайма (разово)
|
||||
|
||||
**Seed-скрипт** (запуск вручную при развёртывании/обновлении стартового набора):
|
||||
@@ -88,20 +90,22 @@ flowchart LR
|
||||
|
||||
Один набор полей — в таблице, в JSON тел запросов/ответов API и в опциональном файле для seed. Согласовать **camelCase в API** и **snake_case в SQL** в `docs/backend.md`.
|
||||
|
||||
| Поле | Обяз. | Примечание |
|
||||
| ------ | ------- | ------------ |
|
||||
| `id` | да | Стабильный ключ, напр. `2026-05-03-kazan-marathon` |
|
||||
| `date` | да | День старта `YYYY-MM-DD` |
|
||||
| `title` | да | Название |
|
||||
| `distanceKm` | да | Число км |
|
||||
| `status` | нет | `planned` / `completed`; иначе можно вывести из даты |
|
||||
| `officialUrl` | нет | Ссылка на организатора |
|
||||
| `startTime` | нет | Напр. `09:30` |
|
||||
| `clusterSchedule` | нет | Многострочный текст |
|
||||
| `bibPickup` | нет | Выдача номеров |
|
||||
| `bibNumber` | нет | Стартовый номер |
|
||||
| `finishTime` | нет | Время H:MM:SS / HH:MM:SS; для PR — перевод в секунды |
|
||||
| `notes` | нет | Заметки |
|
||||
|
||||
| Поле | Обяз. | Примечание |
|
||||
| ----------------- | ----- | ---------------------------------------------------- |
|
||||
| `id` | да | Стабильный ключ, напр. `2026-05-03-kazan-marathon` |
|
||||
| `date` | да | День старта `YYYY-MM-DD` |
|
||||
| `title` | да | Название |
|
||||
| `distanceKm` | да | Число км |
|
||||
| `status` | нет | `planned` / `completed`; иначе можно вывести из даты |
|
||||
| `officialUrl` | нет | Ссылка на организатора |
|
||||
| `startTime` | нет | Напр. `09:30` |
|
||||
| `clusterSchedule` | нет | Многострочный текст |
|
||||
| `bibPickup` | нет | Выдача номеров |
|
||||
| `bibNumber` | нет | Стартовый номер |
|
||||
| `finishTime` | нет | Время H:MM:SS / HH:MM:SS; для PR — перевод в секунды |
|
||||
| `notes` | нет | Заметки |
|
||||
|
||||
|
||||
Опционально в миграциях: `created_at`, `updated_at`.
|
||||
|
||||
@@ -115,12 +119,12 @@ flowchart LR
|
||||
- Если дата **строго до сегодня** (локальная дата пользователя) — показать **результат** и **стартовый номер** (необязательны при первом сохранении).
|
||||
- Если дата в будущем — поля результата скрыты.
|
||||
- Опционально: чекбокс «Уже прошёл» для случая **сегодняшней** даты, чтобы открыть поля результата.
|
||||
- Сохранение: **`POST`** на API → запись в БД.
|
||||
- Сохранение: `**POST`** на API → запись в БД.
|
||||
|
||||
### 6.2 Страница забега
|
||||
|
||||
- Все поля модели; для прошедших — акцент на результат и номер.
|
||||
- Редактирование результата и номера **в любой момент**: **`PATCH`** на API, затем обновление состояния на клиенте (refetch / инвалидация кэша).
|
||||
- Редактирование результата и номера **в любой момент**: `**PATCH`** на API, затем обновление состояния на клиенте (refetch / инвалидация кэша).
|
||||
|
||||
### 6.3 Личные рекорды
|
||||
|
||||
@@ -139,19 +143,21 @@ flowchart LR
|
||||
|
||||
## 7. Документация
|
||||
|
||||
Создать каталог **`docs/`**:
|
||||
Создать каталог `**docs/`**:
|
||||
|
||||
| Файл | Назначение |
|
||||
| ------ | ------------ |
|
||||
| `docs/backend.md` | Docker, `DB_*`, миграции, seed, REST API, CORS |
|
||||
| `docs/frontend.md` | Структура `frontend/`, `VITE_*`, сборка, контракт с API |
|
||||
| `docs/ux-spa.md` | Сценарии, экраны, BEM, кратко про a11y |
|
||||
|
||||
Корневой **`README.md`**: описание проекта, быстрый старт, **ссылки на три файла выше**.
|
||||
| Файл | Назначение |
|
||||
| ------------------ | ------------------------------------------------------- |
|
||||
| `docs/backend.md` | Docker, `DB`_*, миграции, seed, REST API, CORS |
|
||||
| `docs/frontend.md` | Структура `frontend/`, `VITE`_*, сборка, контракт с API |
|
||||
| `docs/ux-spa.md` | Сценарии, экраны, BEM, кратко про a11y |
|
||||
|
||||
|
||||
Корневой `**README.md`**: описание проекта, быстрый старт, **ссылки на три файла выше**.
|
||||
|
||||
## 8. Риски и ограничения
|
||||
|
||||
- **`DB_*` и пароли** — только в окружении сервера API; в git — только `.env.example` без реальных секретов.
|
||||
- `**DB`_* и пароли** — только в окружении сервера API; в git — только `.env.example` без реальных секретов.
|
||||
- Актуальные данные после работы в UI — в **БД**; файлы в git не синхронизируются с правками автоматически. Надёжный бэкап — **резервное копирование PostgreSQL**.
|
||||
- Деплой: Postgres + процесс API с env + статическая раздача фронта (или иная схема хостинга — описать в README).
|
||||
- Данные организаторов (расписание стартов) — **вручную** + ссылка; без парсинга чужих сайтов в объёме первой версии.
|
||||
@@ -171,7 +177,7 @@ flowchart LR
|
||||
## 10. Чеклист задач (implementation todos)
|
||||
|
||||
1. Монорепо: `frontend/` + `backend/`, BEM, токены, роутер.
|
||||
2. Postgres в docker-compose, миграции таблицы `races`, бэкенд читает `DB_*`.
|
||||
2. Postgres в docker-compose, миграции таблицы `races`, бэкенд читает `DB_`*.
|
||||
3. REST CRUD + разовый seed (CSV и/или JSON) → БД.
|
||||
4. Клиент API на фронте, типы, загрузка данных для экранов и PR.
|
||||
5. Экраны месяц и год, модалка по дате.
|
||||
|
||||
24
README.md
Normal file
24
README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Calendar Run
|
||||
|
||||
Calendar Run is a races calendar project with a backend API for storing and querying race events.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. Install dependencies:
|
||||
- `cd backend`
|
||||
- `npm install`
|
||||
2. Configure environment variables in `backend/.env`:
|
||||
- `DB_HOST`, `DB_PORT`, `DB_NAME`, `DB_USER`, `DB_PASSWORD`
|
||||
- Optional API port: `PORT` (priority) or `API_PORT`
|
||||
- **No PostgreSQL (CI / local smoke):** set `CALENDAR_RUN_MOCK_DB=1` (or `true`). Real `DB_`* values are not required; the API uses in-memory stubs for SQL used by the HTTP routes. Do not use mock mode for `npm run db:migrate` or `npm run seed`.
|
||||
3. Build and run backend:
|
||||
- `npm run build`
|
||||
- `npm run dev`
|
||||
|
||||
By default, the API listens on port `3001` if `PORT` and `API_PORT` are not set.
|
||||
|
||||
## Backend And API Docs
|
||||
|
||||
- [Backend API for Frontend](docs/backend-api-for-frontend.md)
|
||||
- [Backend Agent Instruction](docs/agent-backend-instruction.md)
|
||||
- [Backend Sync Fix Instruction](docs/agent-fix-backend-sync-instruction.md)
|
||||
336
agent-frontend-ui-instructions.md
Normal file
336
agent-frontend-ui-instructions.md
Normal file
@@ -0,0 +1,336 @@
|
||||
Ниже — инструкция для дизайн-агента, которая задаёт стиль, структуру и принципы интерфейса для твоего SPA. Она ориентирована на **минимализм, читаемость данных и удовольствие от использования**, а не на “перегруженный фитнес-дэшборд”.
|
||||
|
||||
# 🎯 Общая задача
|
||||
|
||||
Создать **чистый, современный, минималистичный интерфейс** для SPA-приложения бегуна, где пользователь:
|
||||
|
||||
- отслеживает свои старты (прошлые и будущие),
|
||||
- видит прогресс и личные рекорды,
|
||||
- сравнивает результаты,
|
||||
- получает ощущение “контроля над своей беговой историей”.
|
||||
|
||||
---
|
||||
|
||||
# 🧭 Общая философия дизайна
|
||||
|
||||
### 1. “Спокойная сила”, а не “спортивная агрессия”
|
||||
|
||||
Не:
|
||||
|
||||
- кислотные цвета,
|
||||
- перегруженные графики,
|
||||
- “фитнес-клуб стиль 2015”.
|
||||
|
||||
Да:
|
||||
|
||||
- чистый интерфейс,
|
||||
- воздух,
|
||||
- акцент на данных,
|
||||
- ощущение премиальности.
|
||||
|
||||
---
|
||||
|
||||
### 2. Минимум визуального шума
|
||||
|
||||
Каждый экран должен отвечать на вопрос:
|
||||
|
||||
> “Что здесь главное?”
|
||||
|
||||
Если не ясно — убрать лишнее.
|
||||
|
||||
---
|
||||
|
||||
### 3. Данные — главный герой
|
||||
|
||||
Интерфейс не про “украшения”, а про:
|
||||
|
||||
- результаты,
|
||||
- прогресс,
|
||||
- сравнение,
|
||||
- числа.
|
||||
|
||||
---
|
||||
|
||||
# 🎨 Визуальный стиль
|
||||
|
||||
## Цвета
|
||||
|
||||
### Основа:
|
||||
|
||||
- фон: светлый (#F7F8FA или близко)
|
||||
- карточки: белые
|
||||
- текст:
|
||||
- основной: почти чёрный (#111)
|
||||
- вторичный: серый (#666)
|
||||
|
||||
### Акцент:
|
||||
|
||||
- 1 основной цвет:
|
||||
- глубокий синий или изумрудный (например #2F6BFF или #1FA37A)
|
||||
|
||||
### Дополнительно:
|
||||
|
||||
- PR / успех: мягкий зелёный
|
||||
- предупреждения: нейтральный жёлтый
|
||||
- ошибки: мягкий красный
|
||||
|
||||
❗ Никаких “радуг”.
|
||||
|
||||
---
|
||||
|
||||
## Типографика
|
||||
|
||||
- современный sans-serif (Inter / SF Pro / аналог)
|
||||
- крупные числа:
|
||||
- результаты (время) — большие, жирные
|
||||
- иерархия:
|
||||
- H1 — экран
|
||||
- H2 — блок
|
||||
- body — данные
|
||||
- caption — мета
|
||||
|
||||
---
|
||||
|
||||
## Отступы и сетка
|
||||
|
||||
- много воздуха
|
||||
- карточки с padding 16–24px
|
||||
- равномерная вертикальная ритмика
|
||||
- закругления: 12–16px
|
||||
|
||||
---
|
||||
|
||||
# 🧱 Основные экраны
|
||||
|
||||
## 1. Главный экран (Dashboard)
|
||||
|
||||
### Цель:
|
||||
|
||||
дать быстрый ответ:
|
||||
|
||||
- что впереди
|
||||
- где я сейчас
|
||||
- какой прогресс
|
||||
|
||||
### Блоки:
|
||||
|
||||
#### 🔹 Ближайший старт
|
||||
|
||||
- название
|
||||
- дата
|
||||
- дистанция
|
||||
- countdown (“через 12 дней”)
|
||||
|
||||
#### 🔹 Последний результат
|
||||
|
||||
- время
|
||||
- дистанция
|
||||
- место
|
||||
- дата
|
||||
|
||||
#### 🔹 Личный рекорд
|
||||
|
||||
- по ключевой дистанции
|
||||
- выделен визуально
|
||||
|
||||
#### 🔹 Сезон
|
||||
|
||||
- количество стартов
|
||||
- лучший результат
|
||||
- краткая статистика
|
||||
|
||||
---
|
||||
|
||||
## 2. Календарь стартов
|
||||
|
||||
### Два раздела:
|
||||
|
||||
- будущие
|
||||
- прошедшие
|
||||
|
||||
### Карточка старта:
|
||||
|
||||
- название
|
||||
- дата
|
||||
- дистанция
|
||||
- статус:
|
||||
- планирую
|
||||
- зарегистрирован
|
||||
- пробежал
|
||||
|
||||
Минимум кликов.
|
||||
|
||||
---
|
||||
|
||||
## 3. Карточка старта
|
||||
|
||||
- название
|
||||
- дата
|
||||
- дистанция
|
||||
- время
|
||||
- темп
|
||||
- место (если есть)
|
||||
- заметки (опционально)
|
||||
|
||||
---
|
||||
|
||||
## 4. Личные рекорды (PR)
|
||||
|
||||
- список дистанций:
|
||||
- 5K
|
||||
- 10K
|
||||
- 21.1
|
||||
- 42.2
|
||||
|
||||
Для каждой:
|
||||
|
||||
- лучшее время
|
||||
- дата
|
||||
- старт
|
||||
|
||||
---
|
||||
|
||||
## 5. Сравнение стартов (ВАЖНО)
|
||||
|
||||
Это ключевая фича.
|
||||
|
||||
### UI:
|
||||
|
||||
таблица или карточки:
|
||||
|
||||
|
||||
| Год | Время | Темп | Место |
|
||||
| --- | ----- | ---- | ----- |
|
||||
|
||||
|
||||
Можно добавить:
|
||||
|
||||
- стрелки (лучше/хуже)
|
||||
- визуальный прогресс
|
||||
|
||||
---
|
||||
|
||||
# 📊 Графики
|
||||
|
||||
Минимально и аккуратно:
|
||||
|
||||
- линия прогресса по дистанции
|
||||
- без перегруза
|
||||
- без 10 линий сразу
|
||||
|
||||
---
|
||||
|
||||
# 🧩 Компоненты
|
||||
|
||||
- карточки
|
||||
- таблицы (очень аккуратно)
|
||||
- фильтры
|
||||
- переключатели (tabs)
|
||||
- кнопки (primary / secondary)
|
||||
|
||||
---
|
||||
|
||||
# 🧠 UX принципы
|
||||
|
||||
### 1. Минимум кликов
|
||||
|
||||
Любая частая задача:
|
||||
→ максимум 2–3 клика
|
||||
|
||||
---
|
||||
|
||||
### 2. Быстрое считывание
|
||||
|
||||
Пользователь должен за 2 секунды понять:
|
||||
|
||||
- что это
|
||||
- где он
|
||||
- что делать
|
||||
|
||||
---
|
||||
|
||||
### 3. Консистентность
|
||||
|
||||
- одинаковые карточки
|
||||
- одинаковые статусы
|
||||
- одинаковые действия
|
||||
|
||||
---
|
||||
|
||||
# 🧪 Для аналитики (важно)
|
||||
|
||||
Заложить:
|
||||
|
||||
- зоны кликов
|
||||
- понятные CTA
|
||||
- отсутствие “пустых зон”
|
||||
|
||||
---
|
||||
|
||||
# 🖼️ Использование изображений
|
||||
|
||||
## Когда использовать:
|
||||
|
||||
- пустые состояния
|
||||
- onboarding
|
||||
- вдохновение
|
||||
|
||||
## Когда НЕ использовать:
|
||||
|
||||
- в данных
|
||||
- в списках стартов
|
||||
- в результатах
|
||||
|
||||
---
|
||||
|
||||
## Если генерировать изображения
|
||||
|
||||
Стиль:
|
||||
|
||||
- минимализм
|
||||
- спорт без пафоса
|
||||
- одиночный бегун
|
||||
- город / парк
|
||||
- мягкий свет
|
||||
- утро / вечер
|
||||
|
||||
### Пример prompt:
|
||||
|
||||
> “minimalist photo of a runner jogging alone in a city park at sunrise, soft light, calm mood, no crowd, modern aesthetic”
|
||||
|
||||
---
|
||||
|
||||
# 🚫 Чего избегать
|
||||
|
||||
- перегруженных дашбордов
|
||||
- 100 метрик сразу
|
||||
- ярких кислотных цветов
|
||||
- сложных графиков
|
||||
- таблиц как в Excel
|
||||
- лишних иконок
|
||||
- “геймификации ради геймификации”
|
||||
|
||||
---
|
||||
|
||||
# 💡 Вдохновение (по духу)
|
||||
|
||||
Если бы нужно было описать стиль:
|
||||
|
||||
- как Notion, но для бегунов
|
||||
- как Apple Fitness, но менее ярко
|
||||
- как Strava, но более спокойно и чисто
|
||||
|
||||
---
|
||||
|
||||
# 🧭 Финальный ориентир
|
||||
|
||||
Интерфейс должен вызывать ощущение:
|
||||
|
||||
> “Я контролирую свою беговую историю и прогресс”
|
||||
|
||||
а не:
|
||||
|
||||
> “Я заполняю таблицу результатов”
|
||||
|
||||
---
|
||||
|
||||
@@ -11,14 +11,27 @@ function requireEnv(name: string): string {
|
||||
return value;
|
||||
}
|
||||
|
||||
const useMockDb =
|
||||
process.env.CALENDAR_RUN_MOCK_DB === "1" ||
|
||||
process.env.CALENDAR_RUN_MOCK_DB?.toLowerCase() === "true";
|
||||
|
||||
export const config = {
|
||||
db: {
|
||||
host: requireEnv("DB_HOST"),
|
||||
port: parseInt(requireEnv("DB_PORT"), 10),
|
||||
database: requireEnv("DB_NAME"),
|
||||
user: requireEnv("DB_USER"),
|
||||
password: requireEnv("DB_PASSWORD"),
|
||||
},
|
||||
apiPort: parseInt(process.env.API_PORT || "3001", 10),
|
||||
useMockDb,
|
||||
db: useMockDb
|
||||
? {
|
||||
host: "mock",
|
||||
port: 5432,
|
||||
database: "mock",
|
||||
user: "mock",
|
||||
password: "mock",
|
||||
}
|
||||
: {
|
||||
host: requireEnv("DB_HOST"),
|
||||
port: parseInt(requireEnv("DB_PORT"), 10),
|
||||
database: requireEnv("DB_NAME"),
|
||||
user: requireEnv("DB_USER"),
|
||||
password: requireEnv("DB_PASSWORD"),
|
||||
},
|
||||
apiPort: parseInt(process.env.PORT || process.env.API_PORT || "3001", 10),
|
||||
corsOrigin: process.env.CORS_ORIGIN || "http://localhost:5173",
|
||||
};
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import { Pool, PoolConfig } from "pg";
|
||||
import { Pool, PoolConfig, QueryResult, QueryResultRow } from "pg";
|
||||
import { config } from "./config";
|
||||
import type { RaceRow } from "./mappers/race";
|
||||
|
||||
const poolConfig: PoolConfig = {
|
||||
host: config.db.host,
|
||||
@@ -12,13 +13,119 @@ const poolConfig: PoolConfig = {
|
||||
connectionTimeoutMillis: 5_000,
|
||||
};
|
||||
|
||||
export const pool = new Pool(poolConfig);
|
||||
function mockRowFromInsert(sql: string, params: unknown[]): RaceRow {
|
||||
const match = sql.match(/INSERT INTO races\s*\(([^)]+)\)\s*VALUES/i);
|
||||
const now = new Date().toISOString();
|
||||
if (!match) {
|
||||
return {
|
||||
id: String(params[0] ?? ""),
|
||||
race_date: "",
|
||||
title: "",
|
||||
distance_km: "0",
|
||||
status: null,
|
||||
official_url: null,
|
||||
start_time: null,
|
||||
cluster_schedule: null,
|
||||
bib_pickup: null,
|
||||
bib_number: null,
|
||||
finish_time: null,
|
||||
notes: null,
|
||||
created_at: now,
|
||||
updated_at: null,
|
||||
};
|
||||
}
|
||||
const cols = match[1].split(",").map((c) => c.trim());
|
||||
const row: Record<string, unknown> = {};
|
||||
cols.forEach((col, i) => {
|
||||
row[col] = params[i];
|
||||
});
|
||||
return {
|
||||
id: String(row.id ?? ""),
|
||||
race_date: String(row.race_date ?? ""),
|
||||
title: String(row.title ?? ""),
|
||||
distance_km: String(row.distance_km ?? "0"),
|
||||
status: row.status != null ? String(row.status) : null,
|
||||
official_url: row.official_url != null ? String(row.official_url) : null,
|
||||
start_time: row.start_time != null ? String(row.start_time) : null,
|
||||
cluster_schedule: row.cluster_schedule != null ? String(row.cluster_schedule) : null,
|
||||
bib_pickup: row.bib_pickup != null ? String(row.bib_pickup) : null,
|
||||
bib_number: row.bib_number != null ? String(row.bib_number) : null,
|
||||
finish_time: row.finish_time != null ? String(row.finish_time) : null,
|
||||
notes: row.notes != null ? String(row.notes) : null,
|
||||
created_at: now,
|
||||
updated_at: null,
|
||||
};
|
||||
}
|
||||
|
||||
pool.on("error", (err) => {
|
||||
console.error("[db] Unexpected pool error:", err.message);
|
||||
});
|
||||
function createMockPool(): Pool {
|
||||
const emptyResult = <T extends QueryResultRow>(): QueryResult<T> =>
|
||||
({
|
||||
rows: [],
|
||||
rowCount: 0,
|
||||
command: "",
|
||||
oid: 0,
|
||||
fields: [],
|
||||
}) as QueryResult<T>;
|
||||
|
||||
const mockQuery = async <T extends QueryResultRow>(
|
||||
text: string,
|
||||
params?: unknown[],
|
||||
): Promise<QueryResult<T>> => {
|
||||
const sql = text.replace(/\s+/g, " ").trim();
|
||||
const p = params ?? [];
|
||||
|
||||
if (sql.includes("DELETE FROM races")) {
|
||||
return emptyResult();
|
||||
}
|
||||
if (sql.includes("INSERT INTO races") && sql.includes("RETURNING")) {
|
||||
const row = mockRowFromInsert(text, p);
|
||||
return {
|
||||
rows: [row as unknown as T],
|
||||
rowCount: 1,
|
||||
command: "INSERT",
|
||||
oid: 0,
|
||||
fields: [],
|
||||
} as QueryResult<T>;
|
||||
}
|
||||
if (sql.includes("UPDATE races") && sql.includes("RETURNING")) {
|
||||
return emptyResult();
|
||||
}
|
||||
if (sql.includes("SELECT * FROM races")) {
|
||||
return emptyResult();
|
||||
}
|
||||
return emptyResult();
|
||||
};
|
||||
|
||||
const mockPool = {
|
||||
query: mockQuery,
|
||||
connect: async () => {
|
||||
throw new Error(
|
||||
"CALENDAR_RUN_MOCK_DB is enabled: migrate/seed require a real database; unset CALENDAR_RUN_MOCK_DB and configure DB_*.",
|
||||
);
|
||||
},
|
||||
end: async () => {},
|
||||
on() {
|
||||
return mockPool;
|
||||
},
|
||||
};
|
||||
|
||||
return mockPool as unknown as Pool;
|
||||
}
|
||||
|
||||
export const pool = config.useMockDb ? createMockPool() : new Pool(poolConfig);
|
||||
|
||||
if (!config.useMockDb) {
|
||||
pool.on("error", (err) => {
|
||||
console.error("[db] Unexpected pool error:", err.message);
|
||||
});
|
||||
} else {
|
||||
console.warn("[db] Mock database enabled (CALENDAR_RUN_MOCK_DB); no PostgreSQL connection is used.");
|
||||
}
|
||||
|
||||
export async function checkDbConnection(): Promise<boolean> {
|
||||
if (config.useMockDb) {
|
||||
return true;
|
||||
}
|
||||
try {
|
||||
const client = await pool.connect();
|
||||
client.release();
|
||||
|
||||
@@ -4,26 +4,77 @@ import { rowToDto, bodyToColumns, RaceRow } from "../mappers/race";
|
||||
|
||||
const router = Router();
|
||||
|
||||
type ValidationErrorBody = {
|
||||
error: "validation_error";
|
||||
details: string[];
|
||||
};
|
||||
|
||||
function dbError(res: Response) {
|
||||
res.status(503).json({ error: "database_unavailable" });
|
||||
}
|
||||
|
||||
function validationError(res: Response, details: string[]) {
|
||||
const body: ValidationErrorBody = { error: "validation_error", details };
|
||||
res.status(400).json(body);
|
||||
}
|
||||
|
||||
function parseOptionalIntegerQuery(
|
||||
value: unknown,
|
||||
fieldName: string,
|
||||
min?: number,
|
||||
max?: number,
|
||||
): { value?: number; error?: string } {
|
||||
if (value == null) {
|
||||
return {};
|
||||
}
|
||||
if (typeof value !== "string" || value.trim() === "") {
|
||||
return { error: `${fieldName} must be an integer` };
|
||||
}
|
||||
|
||||
const normalized = value.trim();
|
||||
if (!/^-?\d+$/.test(normalized)) {
|
||||
return { error: `${fieldName} must be an integer` };
|
||||
}
|
||||
|
||||
const parsed = Number(normalized);
|
||||
if (!Number.isInteger(parsed)) {
|
||||
return { error: `${fieldName} must be an integer` };
|
||||
}
|
||||
|
||||
if (min != null && parsed < min) {
|
||||
return { error: `${fieldName} must be between ${min} and ${max}` };
|
||||
}
|
||||
if (max != null && parsed > max) {
|
||||
return { error: `${fieldName} must be between ${min} and ${max}` };
|
||||
}
|
||||
|
||||
return { value: parsed };
|
||||
}
|
||||
|
||||
/* ─── GET /races ──────────────────────────────────────────── */
|
||||
|
||||
router.get("/races", async (req: Request, res: Response) => {
|
||||
const yearResult = parseOptionalIntegerQuery(req.query.year, "year");
|
||||
const monthResult = parseOptionalIntegerQuery(req.query.month, "month", 1, 12);
|
||||
const details = [yearResult.error, monthResult.error].filter(Boolean) as string[];
|
||||
|
||||
if (details.length > 0) {
|
||||
validationError(res, details);
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const { year, month } = req.query;
|
||||
const conditions: string[] = [];
|
||||
const params: unknown[] = [];
|
||||
let idx = 1;
|
||||
|
||||
if (year) {
|
||||
if (yearResult.value != null) {
|
||||
conditions.push(`EXTRACT(YEAR FROM race_date) = $${idx++}`);
|
||||
params.push(Number(year));
|
||||
params.push(yearResult.value);
|
||||
}
|
||||
if (month) {
|
||||
if (monthResult.value != null) {
|
||||
conditions.push(`EXTRACT(MONTH FROM race_date) = $${idx++}`);
|
||||
params.push(Number(month));
|
||||
params.push(monthResult.value);
|
||||
}
|
||||
|
||||
const where = conditions.length ? `WHERE ${conditions.join(" AND ")}` : "";
|
||||
@@ -46,7 +97,7 @@ router.get("/races/:id", async (req: Request, res: Response) => {
|
||||
[req.params.id],
|
||||
);
|
||||
if (rows.length === 0) {
|
||||
res.status(404).json({ error: "not_found" });
|
||||
res.status(404).json({ error: "not_found", details: ["Race not found"] });
|
||||
return;
|
||||
}
|
||||
res.json(rowToDto(rows[0]));
|
||||
@@ -62,10 +113,7 @@ router.post("/races", async (req: Request, res: Response) => {
|
||||
const body = req.body;
|
||||
|
||||
if (!body.id || !body.date || !body.title || body.distanceKm == null) {
|
||||
res.status(400).json({
|
||||
error: "validation_error",
|
||||
details: ["Fields id, date, title, distanceKm are required"],
|
||||
});
|
||||
validationError(res, ["Fields id, date, title, distanceKm are required"]);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -81,7 +129,10 @@ router.post("/races", async (req: Request, res: Response) => {
|
||||
res.status(201).json(rowToDto(rows[0]));
|
||||
} catch (err: any) {
|
||||
if (err.code === "23505") {
|
||||
res.status(409).json({ error: "conflict", details: ["Race with this id already exists"] });
|
||||
res.status(409).json({
|
||||
error: "conflict",
|
||||
details: ["Race with this id already exists"],
|
||||
});
|
||||
return;
|
||||
}
|
||||
console.error("[POST /races]", err);
|
||||
@@ -95,10 +146,7 @@ router.patch("/races/:id", async (req: Request, res: Response) => {
|
||||
const { columns, values } = bodyToColumns(req.body);
|
||||
|
||||
if (columns.length === 0) {
|
||||
res.status(400).json({
|
||||
error: "validation_error",
|
||||
details: ["No updatable fields provided"],
|
||||
});
|
||||
validationError(res, ["No updatable fields provided"]);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -110,7 +158,7 @@ router.patch("/races/:id", async (req: Request, res: Response) => {
|
||||
try {
|
||||
const { rows } = await pool.query<RaceRow>(sql, values);
|
||||
if (rows.length === 0) {
|
||||
res.status(404).json({ error: "not_found" });
|
||||
res.status(404).json({ error: "not_found", details: ["Race not found"] });
|
||||
return;
|
||||
}
|
||||
res.json(rowToDto(rows[0]));
|
||||
@@ -129,7 +177,7 @@ router.delete("/races/:id", async (req: Request, res: Response) => {
|
||||
[req.params.id],
|
||||
);
|
||||
if (rowCount === 0) {
|
||||
res.status(404).json({ error: "not_found" });
|
||||
res.status(404).json({ error: "not_found", details: ["Race not found"] });
|
||||
return;
|
||||
}
|
||||
res.status(204).end();
|
||||
|
||||
77
docs/agent-fix-backend-sync-instruction.md
Normal file
77
docs/agent-fix-backend-sync-instruction.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Инструкция агенту: устранение рассинхронизации backend с планом/контрактом
|
||||
|
||||
Документ описывает, как выполнить план исправлений **только через изменения кода** (без правок существующей документации в `docs/`).
|
||||
|
||||
## 1) Ветка и границы задачи
|
||||
|
||||
- Создать отдельную ветку по best practice, например: `fix/backend-api-validation-and-runtime-sync`.
|
||||
- Не менять существующие файлы документации в `docs/` как способ "починить" замечания.
|
||||
- Исправления вносятся в runtime-код и обязательные артефакты репозитория.
|
||||
|
||||
## 2) Обязательные изменения в коде
|
||||
|
||||
### A. Строгая валидация `GET /races`
|
||||
|
||||
Файл: `backend/src/routes/races.ts`
|
||||
|
||||
- Добавить явную проверку `year`:
|
||||
- целое число;
|
||||
- при невалидном значении вернуть `400`:
|
||||
- `{"error":"validation_error","details":[...]}`
|
||||
- Добавить явную проверку `month`:
|
||||
- целое число в диапазоне `1..12`;
|
||||
- при невалидном значении вернуть `400` в том же формате.
|
||||
- Исключить передачу `NaN`/некорректных значений в SQL-параметры.
|
||||
|
||||
### B. Разделение ошибок валидации и ошибок БД
|
||||
|
||||
Файл: `backend/src/routes/races.ts`
|
||||
|
||||
- `400` использовать только для ошибок входа (query/body/params).
|
||||
- `503 {"error":"database_unavailable"}` использовать только для технической недоступности БД.
|
||||
- Сохранить единый JSON-формат ошибок во всех CRUD-маршрутах.
|
||||
|
||||
### C. Выравнивание конфигурации порта
|
||||
|
||||
Файл: `backend/src/config.ts`
|
||||
|
||||
- Поддержать оба env-подхода:
|
||||
- приоритет `PORT`,
|
||||
- затем `API_PORT`,
|
||||
- затем fallback `3001`.
|
||||
|
||||
### D. Обязательный root-артефакт
|
||||
|
||||
Файл: `README.md` (в корне)
|
||||
|
||||
- Создать базовый `README.md` с:
|
||||
- кратким описанием проекта,
|
||||
- минимальным quick start,
|
||||
- ссылками на текущие документы backend/API.
|
||||
|
||||
## 3) Допустимая реорганизация кода
|
||||
|
||||
- Можно добавить небольшие локальные helper-функции в `backend/src/routes/races.ts`.
|
||||
- При необходимости можно вынести общие mapper/validator-хелперы в `backend/src/mappers/race.ts`, если это уменьшает дублирование.
|
||||
- Не усложнять архитектуру: только то, что нужно для контракта и устойчивого поведения API.
|
||||
|
||||
## 4) Проверка результата
|
||||
|
||||
Минимум выполнить:
|
||||
|
||||
1. `npm run build` в `backend/` (типизация/сборка).
|
||||
2. Проверка диагностики/линтов по измененным backend-файлам.
|
||||
3. Smoke-сценарии API:
|
||||
- `GET /health` -> `200`,
|
||||
- `GET /ready` -> `200` при доступной БД или `503` при недоступной,
|
||||
- `GET /races?year=bad` -> `400`,
|
||||
- `GET /races?month=13` -> `400`,
|
||||
- `GET /races?year=2026&month=5` -> корректный `200` и данные/пустой массив.
|
||||
|
||||
## 5) Критерии готовности (Definition of Done)
|
||||
|
||||
- Контракт валидации `GET /races` соблюден в runtime.
|
||||
- Валидационные ошибки не маскируются под `database_unavailable`.
|
||||
- Конфиг порта поддерживает `PORT` и `API_PORT` с правильным приоритетом.
|
||||
- В репозитории есть корневой `README.md`.
|
||||
- Никакие существующие документы в `docs/` не менялись для "закрытия" замечаний.
|
||||
12
frontend/index.html
Normal file
12
frontend/index.html
Normal file
@@ -0,0 +1,12 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Calendar Run</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
<script type="module" src="/src/main.tsx"></script>
|
||||
</body>
|
||||
</html>
|
||||
1796
frontend/package-lock.json
generated
Normal file
1796
frontend/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
24
frontend/package.json
Normal file
24
frontend/package.json
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "calendar-run-frontend",
|
||||
"private": true,
|
||||
"version": "0.1.0",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
"build": "vite build",
|
||||
"preview": "vite preview"
|
||||
},
|
||||
"dependencies": {
|
||||
"react": "^18.3.1",
|
||||
"react-dom": "^18.3.1",
|
||||
"react-router-dom": "^6.30.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.7.5",
|
||||
"@types/react": "^18.3.8",
|
||||
"@types/react-dom": "^18.3.1",
|
||||
"@vitejs/plugin-react": "^4.3.2",
|
||||
"typescript": "^5.6.2",
|
||||
"vite": "^5.4.8"
|
||||
}
|
||||
}
|
||||
1
frontend/src/api/index.ts
Normal file
1
frontend/src/api/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export {};
|
||||
33
frontend/src/app/layouts/AppLayout.tsx
Normal file
33
frontend/src/app/layouts/AppLayout.tsx
Normal file
@@ -0,0 +1,33 @@
|
||||
import { NavLink, Outlet } from "react-router-dom";
|
||||
|
||||
export function AppLayout(): JSX.Element {
|
||||
return (
|
||||
<div className="app-shell">
|
||||
<header className="app-shell__header">
|
||||
<div className="app-shell__brand">Calendar Run</div>
|
||||
<nav className="app-shell__nav" aria-label="Primary navigation">
|
||||
<NavLink
|
||||
to="/"
|
||||
end
|
||||
className={({ isActive }) =>
|
||||
isActive ? "app-shell__link app-shell__link--active" : "app-shell__link"
|
||||
}
|
||||
>
|
||||
Dashboard
|
||||
</NavLink>
|
||||
<NavLink
|
||||
to="/races"
|
||||
className={({ isActive }) =>
|
||||
isActive ? "app-shell__link app-shell__link--active" : "app-shell__link"
|
||||
}
|
||||
>
|
||||
Races
|
||||
</NavLink>
|
||||
</nav>
|
||||
</header>
|
||||
<main className="app-shell__main">
|
||||
<Outlet />
|
||||
</main>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
15
frontend/src/app/router.tsx
Normal file
15
frontend/src/app/router.tsx
Normal file
@@ -0,0 +1,15 @@
|
||||
import { createBrowserRouter } from "react-router-dom";
|
||||
import { AppLayout } from "./layouts/AppLayout";
|
||||
import { DashboardPage } from "../pages/DashboardPage";
|
||||
import { RacesPage } from "../pages/RacesPage";
|
||||
|
||||
export const appRouter = createBrowserRouter([
|
||||
{
|
||||
path: "/",
|
||||
element: <AppLayout />,
|
||||
children: [
|
||||
{ index: true, element: <DashboardPage /> },
|
||||
{ path: "races", element: <RacesPage /> }
|
||||
]
|
||||
}
|
||||
]);
|
||||
1
frontend/src/components/index.ts
Normal file
1
frontend/src/components/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export {};
|
||||
1
frontend/src/features/index.ts
Normal file
1
frontend/src/features/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export {};
|
||||
1
frontend/src/lib/index.ts
Normal file
1
frontend/src/lib/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export {};
|
||||
12
frontend/src/main.tsx
Normal file
12
frontend/src/main.tsx
Normal file
@@ -0,0 +1,12 @@
|
||||
import React from "react";
|
||||
import ReactDOM from "react-dom/client";
|
||||
import { RouterProvider } from "react-router-dom";
|
||||
import { appRouter } from "./app/router";
|
||||
import "./styles/tokens.css";
|
||||
import "./styles/global.css";
|
||||
|
||||
ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
|
||||
<React.StrictMode>
|
||||
<RouterProvider router={appRouter} />
|
||||
</React.StrictMode>
|
||||
);
|
||||
8
frontend/src/pages/DashboardPage.tsx
Normal file
8
frontend/src/pages/DashboardPage.tsx
Normal file
@@ -0,0 +1,8 @@
|
||||
export function DashboardPage(): JSX.Element {
|
||||
return (
|
||||
<section className="page page--dashboard">
|
||||
<h1 className="page__title">Dashboard</h1>
|
||||
<p className="page__subtitle">Overview cards and quick actions will be added in the next task.</p>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
8
frontend/src/pages/RacesPage.tsx
Normal file
8
frontend/src/pages/RacesPage.tsx
Normal file
@@ -0,0 +1,8 @@
|
||||
export function RacesPage(): JSX.Element {
|
||||
return (
|
||||
<section className="page page--races">
|
||||
<h1 className="page__title">Races</h1>
|
||||
<p className="page__subtitle">Upcoming and completed race lists will be added in the next task.</p>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
93
frontend/src/styles/global.css
Normal file
93
frontend/src/styles/global.css
Normal file
@@ -0,0 +1,93 @@
|
||||
*,
|
||||
*::before,
|
||||
*::after {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html,
|
||||
body,
|
||||
#root {
|
||||
min-height: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
font-family: var(--font-family-base);
|
||||
font-size: var(--font-size-body);
|
||||
line-height: var(--line-height-base);
|
||||
background: var(--color-bg);
|
||||
color: var(--color-text);
|
||||
}
|
||||
|
||||
a {
|
||||
color: inherit;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.app-shell {
|
||||
min-height: 100vh;
|
||||
display: grid;
|
||||
grid-template-rows: auto 1fr;
|
||||
}
|
||||
|
||||
.app-shell__header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
gap: var(--space-4);
|
||||
padding: var(--space-4) var(--space-6);
|
||||
background: var(--color-surface);
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.app-shell__brand {
|
||||
font-size: var(--font-size-h2);
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.app-shell__nav {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-2);
|
||||
}
|
||||
|
||||
.app-shell__link {
|
||||
padding: var(--space-2) var(--space-3);
|
||||
border-radius: var(--radius-sm);
|
||||
color: var(--color-text-muted);
|
||||
}
|
||||
|
||||
.app-shell__link:hover,
|
||||
.app-shell__link:focus-visible {
|
||||
color: var(--color-text);
|
||||
background: #eef2f6;
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.app-shell__link--active {
|
||||
color: var(--color-surface);
|
||||
background: var(--color-accent);
|
||||
}
|
||||
|
||||
.app-shell__main {
|
||||
width: min(1080px, 100%);
|
||||
margin: 0 auto;
|
||||
padding: var(--space-6);
|
||||
}
|
||||
|
||||
.page {
|
||||
background: var(--color-surface);
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: var(--radius-md);
|
||||
padding: var(--space-6);
|
||||
}
|
||||
|
||||
.page__title {
|
||||
margin: 0 0 var(--space-2);
|
||||
font-size: var(--font-size-h1);
|
||||
}
|
||||
|
||||
.page__subtitle {
|
||||
margin: 0;
|
||||
color: var(--color-text-muted);
|
||||
}
|
||||
29
frontend/src/styles/tokens.css
Normal file
29
frontend/src/styles/tokens.css
Normal file
@@ -0,0 +1,29 @@
|
||||
:root {
|
||||
--color-bg: #f3f5f7;
|
||||
--color-surface: #ffffff;
|
||||
--color-text: #13202b;
|
||||
--color-text-muted: #5d6b77;
|
||||
--color-accent: #1f7ae0;
|
||||
--color-border: #dce2e8;
|
||||
--color-success: #2f9e63;
|
||||
--color-warning: #c0821f;
|
||||
--color-error: #cc3a3a;
|
||||
|
||||
--font-family-base: "Inter", "Segoe UI", Arial, sans-serif;
|
||||
--font-size-h1: 2rem;
|
||||
--font-size-h2: 1.5rem;
|
||||
--font-size-body: 1rem;
|
||||
--font-size-caption: 0.875rem;
|
||||
--line-height-base: 1.5;
|
||||
|
||||
--space-2: 0.5rem;
|
||||
--space-3: 0.75rem;
|
||||
--space-4: 1rem;
|
||||
--space-5: 1.25rem;
|
||||
--space-6: 1.5rem;
|
||||
--space-8: 2rem;
|
||||
|
||||
--radius-sm: 0.375rem;
|
||||
--radius-md: 0.75rem;
|
||||
--radius-lg: 1rem;
|
||||
}
|
||||
17
frontend/tsconfig.app.json
Normal file
17
frontend/tsconfig.app.json
Normal file
@@ -0,0 +1,17 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"useDefineForClassFields": true,
|
||||
"lib": ["ES2020", "DOM", "DOM.Iterable"],
|
||||
"module": "ESNext",
|
||||
"skipLibCheck": true,
|
||||
"moduleResolution": "Bundler",
|
||||
"allowImportingTsExtensions": false,
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"noEmit": true,
|
||||
"jsx": "react-jsx",
|
||||
"strict": true
|
||||
},
|
||||
"include": ["src"]
|
||||
}
|
||||
1
frontend/tsconfig.app.tsbuildinfo
Normal file
1
frontend/tsconfig.app.tsbuildinfo
Normal file
@@ -0,0 +1 @@
|
||||
{"root":["./src/main.tsx","./src/api/index.ts","./src/app/router.tsx","./src/app/layouts/applayout.tsx","./src/components/index.ts","./src/features/index.ts","./src/lib/index.ts","./src/pages/dashboardpage.tsx","./src/pages/racespage.tsx"],"version":"5.9.3"}
|
||||
7
frontend/tsconfig.json
Normal file
7
frontend/tsconfig.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"files": [],
|
||||
"references": [
|
||||
{ "path": "./tsconfig.app.json" },
|
||||
{ "path": "./tsconfig.node.json" }
|
||||
]
|
||||
}
|
||||
13
frontend/tsconfig.node.json
Normal file
13
frontend/tsconfig.node.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"composite": true,
|
||||
"target": "ES2020",
|
||||
"lib": ["ES2020"],
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "Bundler",
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"types": ["node"],
|
||||
"strict": true
|
||||
},
|
||||
"include": ["vite.config.ts"]
|
||||
}
|
||||
1
frontend/tsconfig.node.tsbuildinfo
Normal file
1
frontend/tsconfig.node.tsbuildinfo
Normal file
File diff suppressed because one or more lines are too long
2
frontend/vite.config.d.ts
vendored
Normal file
2
frontend/vite.config.d.ts
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
declare const _default: import("vite").UserConfig;
|
||||
export default _default;
|
||||
5
frontend/vite.config.js
Normal file
5
frontend/vite.config.js
Normal file
@@ -0,0 +1,5 @@
|
||||
import { defineConfig } from "vite";
|
||||
import react from "@vitejs/plugin-react";
|
||||
export default defineConfig({
|
||||
plugins: [react()]
|
||||
});
|
||||
6
frontend/vite.config.ts
Normal file
6
frontend/vite.config.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
import { defineConfig } from "vite";
|
||||
import react from "@vitejs/plugin-react";
|
||||
|
||||
export default defineConfig({
|
||||
plugins: [react()]
|
||||
});
|
||||
Reference in New Issue
Block a user