Skip to content

docs: polish README for interview (Render Blueprint + checks) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iBubenok merged 1 commit into from
Oct 30, 2025
Merged

docs: polish README for interview (Render Blueprint + checks) #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \
* `409 Conflict` — повторная бронь того же пользователя **или** мест больше нет
* `503 Service Unavailable` — БД не настроена (`DATABASE_URL` не задан)
* `500 Internal Error` — непредвиденная ошибка
* **Ограничение частоты**: на `POST /api/bookings/reserve` действует rate-limit **30 запросов/мин** на IP (помогает от случайных/скриптовых «бурстов»).
* **Ограничение частоты**: на `POST /api/bookings/reserve` действует rate-limit **30 запросов/мин** на IP.

---

Expand All @@ -124,6 +124,8 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \

## Быстрый старт (локально)

**Требования:** Node.js 18+; доступная PostgreSQL (или облачная строка подключения).

1. Установите зависимости:

```bash
Expand All @@ -134,7 +136,7 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \
```dotenv
PORT=3000
DATABASE_URL=postgres://user:password@host:5432/dbname
# Включайте SSL для облачных БД (Neon/Render и т.п.)
# Для облачных БД (Neon/Render) включите SSL:
DATABASE_SSL=true
```
3. Запуск:
Expand All @@ -150,6 +152,11 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \
### Миграции

Выполните файл `db/migrations.sql` в вашей БД (создаёт таблицы, индексы и сид-данные).
Пример через `psql`:

```bash
psql "postgresql://USER:[email protected]:PORT/DB?sslmode=require" -f db/migrations.sql
```

---

Expand All @@ -159,7 +166,7 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \
.
├─ db/
│ └─ migrations.sql # таблицы, индексы, сиды
├─ __tests__/ # (опц.) автотесты
├─ __tests__/ # автотесты
├─ openapi.yaml # спецификация OpenAPI для Swagger UI
├─ server.js # запуск приложения, graceful shutdown
├─ package.json
Expand All @@ -174,4 +181,4 @@ curl -i -X POST https://booking-api-mwff.onrender.com/api/bookings/reserve \
* **CI**: GitHub Actions (`.github/workflows/ci.yml`) выполняет `npm ci` и `npm test` на каждый `push`/`PR`.
* **CD**: Render Blueprint (`render.yaml`) автодеплоит ветку `main`; `/health` используется как health-check.

---
---