Skip to content

Commit 8244f3f

Browse files
committed
docs: уточнить README по .env и структуре разделов
- Убрана секция с дальнейшими шагами - Уточнена обязательность переменных для compose и локального запуска - Опциональные переменные вынесены в отдельный блок
1 parent 71c2a0f commit 8244f3f

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737
| Слой | Инструменты |
3838
|---|---|
3939
| API | FastAPI, Pydantic |
40-
| Бизнес-логика | Services, Repositories |
40+
| Бизнес-логика | Services |
41+
| Доступ к данным | Repositories |
4142
| БД | PostgreSQL, SQLAlchemy 2.0 (async), Alembic |
4243
| Кэш / лимиты | Redis |
4344
| Безопасность | JWT (access/refresh), Argon2, rate limiting |
@@ -108,11 +109,27 @@
108109

109110
### 1. Подготовить `.env`
110111

111-
Минимально нужны:
112+
Для запуска через Docker Compose минимально нужны:
112113

113114
```env
114115
POSTGRES_PASSWORD=your_strong_password
115116
SECRET_KEY=your_secret_key_min_32_chars
117+
```
118+
119+
Для запуска без Docker (через `uv run uvicorn`) обязательно нужны:
120+
121+
```env
122+
DATABASE_URL=postgresql+asyncpg://task_user:task_password@localhost:5432/task_manager
123+
SECRET_KEY=your_secret_key_min_32_chars
124+
```
125+
126+
Опционально можно переопределить (иначе берутся default из `app/config.py`):
127+
128+
```env
129+
ALGORITHM=HS256
130+
REDIS_URL=redis://localhost:6379/0
131+
ACCESS_TOKEN_EXPIRE_MINUTES=10
132+
REFRESH_TOKEN_EXPIRE_DAYS=7
116133
GRAFANA_ADMIN_USER=admin
117134
GRAFANA_ADMIN_PASSWORD=admin
118135
```
@@ -266,9 +283,3 @@ monitoring/
266283
load/
267284
locustfile.py
268285
```
269-
270-
## Что дальше
271-
272-
- SonarCloud quality gate
273-
- финальная полировка README примерами API-ответов
274-
- разворот CD в отдельную deployment-среду

0 commit comments

Comments
 (0)