Update readme 3.6
This commit is contained in:
40
README.md
40
README.md
@@ -8,12 +8,16 @@ Pet-проект на стеке **FastAPI + SQLAlchemy (async) + Pydantic + Pyt
|
||||
## 📂 Структура проекта
|
||||
```
|
||||
/
|
||||
├── server/ # исходный код: модели, маршруты, JWT, базы данных
|
||||
├── run.py # точка входа, запуск приложения
|
||||
├── requirements.txt # зависимости
|
||||
├── .env # переменные окружения
|
||||
├── README.md # этот файл
|
||||
└── Plan # заметки / TODO / планы по проекту
|
||||
├── server/backend # Исходный код: endpoints, pydantic, JWT, отправка паролей на почту, permissions, rate-limiting
|
||||
├── server/frontend # Странички login, registration, reset-password, main
|
||||
├── server/database # База данных, alembic, db_balancer(не настроен, как шаблон)
|
||||
├── server/testing # pytests
|
||||
├── run.py # Точка входа, запуск приложения
|
||||
├── makefile # Точка входа, запуск приложения и утилит
|
||||
├── requirements.txt # Зависимости
|
||||
├── .env # Переменные окружения
|
||||
└── README.md # Этот файл
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
@@ -33,8 +37,8 @@ Pet-проект на стеке **FastAPI + SQLAlchemy (async) + Pydantic + Pyt
|
||||
```
|
||||
2. Создать и активировать виртуальное окружение:
|
||||
```
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate # Linux / macOS
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate # Linux / macOS
|
||||
venv\Scripts\activate # Windows
|
||||
```
|
||||
|
||||
@@ -52,13 +56,16 @@ ALLOW_HEADERS=*
|
||||
JWT_SECRET_KEY=your_secret_key
|
||||
ACCESS_TOKEN_EXPIRE_MINUTES=30
|
||||
```
|
||||
|
||||
5. Запустить приложение:
|
||||
5. Мигрировать БД:
|
||||
```
|
||||
python run.py
|
||||
make migrate_head
|
||||
```
|
||||
6. Запустить приложение:
|
||||
```
|
||||
python run.py или вне окружения сразу прописать make run
|
||||
```
|
||||
|
||||
6. Документация OpenAPI будет доступна по адресу:
|
||||
7. Документация OpenAPI будет доступна по адресу:
|
||||
```
|
||||
• Swagger UI → http://localhost:8000/docs
|
||||
• JSON схема → http://localhost:8000/openapi.json
|
||||
@@ -93,9 +100,9 @@ username=<email>&password=<пароль>
|
||||
|
||||
Запуск всех тестов:
|
||||
```
|
||||
pytest
|
||||
make test
|
||||
```
|
||||
Тестируются:
|
||||
Тестируются (В планах):
|
||||
```
|
||||
• CRUD операции
|
||||
• Pydantic-схемы
|
||||
@@ -106,11 +113,6 @@ pytest
|
||||
|
||||
✅ TODO
|
||||
```
|
||||
• Миграции через Alembic
|
||||
• Обработка ошибок ✅
|
||||
• Логирование ✅
|
||||
• PostgreSQL + Pgpool-II для продакшена ✅
|
||||
• Разделение схем Pydantic на вход/выход ✅
|
||||
• Тестирование edge-cases
|
||||
```
|
||||
⸻
|
||||
|
||||
Reference in New Issue
Block a user