28 lines
660 B
Markdown
28 lines
660 B
Markdown
# {Project Name}
|
|
|
|
{Одна строка описания проекта}
|
|
|
|
## Быстрый старт
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
# Редактировать .env
|
|
|
|
pip install -r requirements.txt
|
|
|
|
uvicorn app.main:app --reload
|
|
```
|
|
|
|
## Разработка
|
|
|
|
Проект следует правилам, описанным в `docs/`. Обязательно прочитайте:
|
|
1. `docs/00-rules.md` — основные правила
|
|
2. `docs/03-project-structure.md` — структура проекта
|
|
3. `docs/01-architecture.md` — архитектура
|
|
|
|
## API
|
|
|
|
- `/docs` — Swagger UI
|
|
- `/redoc` — ReDoc
|
|
- `/openapi.json` — OpenAPI spec
|