Initial commit: site monorepo with API, web, and infra.
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# Документация Compton
|
||||
|
||||
README в корне — только «как запустить за 30 секунд». Всё остальное — здесь.
|
||||
|
||||
Мы сознательно держим **мало файлов**, но каждый — **плотный**: таблицы, схемы, команды. Можно с лёгким юмором, но без простыней на 500 строк.
|
||||
|
||||
## Карта
|
||||
|
||||
| Документ | Когда открывать |
|
||||
|----------|-----------------|
|
||||
| [project.md](./project.md) | «Где что лежит?», архитектура, API, маршруты, env |
|
||||
| [deploy.md](./deploy.md) | Запуск, **стандартные логины dev**, staging/prod, troubleshooting |
|
||||
| [security.md](./security.md) | Auth, JWT revoke, секреты, nginx, чеклист prod |
|
||||
| [release.md](./release.md) | Перед выкладкой: E2E, k6, ZAP, Lighthouse, smoke |
|
||||
| [TZ.md](./TZ.md) | Полное ТЗ — источник правды по требованиям |
|
||||
|
||||
## Быстрые ссылки
|
||||
|
||||
```bash
|
||||
# dev
|
||||
python apps/api/scripts/bootstrap_install.py
|
||||
docker compose --profile docker-web up -d --build
|
||||
|
||||
# тесты
|
||||
pnpm --filter web test:ci
|
||||
cd apps/api && python -m pytest --cov=app --cov-fail-under=90
|
||||
|
||||
# prod smoke (после деплоя)
|
||||
./infra/scripts/smoke-prod.sh https://your-domain.com
|
||||
```
|
||||
|
||||
## Что куда не кладём
|
||||
|
||||
| Не в git | Почему |
|
||||
|----------|--------|
|
||||
| `apps/api/data/secrets/install.env` | пароли БД, JWT, MinIO |
|
||||
| `.env`, `apps/api/.env` | локальные секреты |
|
||||
| `apps/api/data/logs/` | runtime-логи |
|
||||
| `node_modules/`, `.venv/` | очевидно |
|
||||
|
||||
Если секрет утёк в git — считайте его скомпрометированным. Force-push не спасает совесть.
|
||||
Reference in New Issue
Block a user