a4f8c37b84
Some checks failed
CI / build-and-test (pull_request) Has been cancelled
Rename stack service from backend to runners-calendar-backend so DNS on shared external networks (e.g. postgres_default) cannot resolve to another project’s backend. Nginx proxy_pass targets the same hostname. Made-with: Cursor
50 lines
3.1 KiB
Markdown
50 lines
3.1 KiB
Markdown
# Calendar Run
|
||
|
||
Монорепозиторий: **backend** (Express + PostgreSQL) и **frontend** (React + Vite) — календарь забегов.
|
||
|
||
## Переменные окружения
|
||
|
||
Один шаблон для локальной разработки и для Docker-стека: `**[.env.example](.env.example)`** → скопируйте в `**.env**` в корне репозитория.
|
||
|
||
Там же перечислены `**DB_HOST**`, `**DB_PORT**`, `**DB_NAME**`, `**DB_USER**`, `**DB_PASSWORD**` (подключение бэкенда к БД), `**PORT**` / `**API_PORT**`, опционально `**CALENDAR_RUN_MOCK_DB**` и `**CORS_ORIGIN**`.
|
||
|
||
## Backend — локально
|
||
|
||
1. `cd backend && npm install`
|
||
2. Корень: `cp .env.example .env`, задайте `DB_*` (и при необходимости `CORS_ORIGIN`).
|
||
3. Postgres: из корня `docker compose up -d` (см. `[docker-compose.yml](docker-compose.yml)`) — в compose используются те же `DB_NAME`, `DB_USER`, `DB_PASSWORD` из `.env`.
|
||
4. `cd backend && npm run db:migrate && npm run seed`
|
||
5. Dev-режим: `npm run dev`
|
||
6. Или production: `npm run build && npm start`
|
||
|
||
Без PostgreSQL (только smoke API): в `.env` задайте `CALENDAR_RUN_MOCK_DB=1`; `**db:migrate` и `seed` с mock не использовать**.
|
||
|
||
## Frontend — локально
|
||
|
||
```bash
|
||
cd frontend
|
||
cp .env.example .env
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
Фронт всегда отправляет запросы на относительный префикс `**/api**`. В dev это проксирует Vite на `http://localhost:3001`, в Docker/проде — nginx фронта проксирует на `runners-calendar-backend:3000`. У бэкенда `CORS_ORIGIN` должен совпадать с origin приложения (например `http://localhost:5173`).
|
||
|
||
## Docker: backend + frontend рядом с Postgres
|
||
|
||
Используйте `[docker-compose.stack.yml](docker-compose.stack.yml)`: общая **внешняя** сеть с контейнером Postgres (как в вашей инфраструктуре). В корне должен быть `**.env`** (из `.env.example`): `DB_HOST` — имя сервиса/контейнера Postgres в этой сети, `DB_PORT=5432`, плюс остальные `DB_*` и `**CORS_ORIGIN=http://localhost:3033**`, если заходите на фронт с хоста на порту 3033.
|
||
|
||
```bash
|
||
docker compose -f docker-compose.stack.yml up -d --build
|
||
docker compose -f docker-compose.stack.yml exec runners-calendar-backend node dist/migrate.js
|
||
docker compose -f docker-compose.stack.yml exec runners-calendar-backend node dist/seed.js
|
||
```
|
||
|
||
Фронт в браузере обращается к API по префиксу `**/api**` (nginx в образе фронта проксирует на сервис `runners-calendar-backend` в той же сети).
|
||
|
||
## Документация API и бэкенда
|
||
|
||
- [Шпаргалка API для фронта](docs/backend-api-for-frontend.md)
|
||
- [Эксплуатация backend](docs/backend.md)
|
||
|