Add readme, screenshots and small fixes

This commit is contained in:
2024-06-22 14:36:54 +04:00
parent c516ba920c
commit 7b2f270913
7 changed files with 45 additions and 3 deletions

42
README.md Normal file
View File

@@ -0,0 +1,42 @@
# .Torrent backend
> .Torrent - сервис обмена .torrent файлами видеоигр, фильмов и аудиокниг
## Стек
- Python 3.12
- FastAPI (REST API)
- Pydantic
- SQLAlchemy (ORM, async)
- и другие
- Typer
- dotenv
- asyncio и aiofiles
- Pillow
- hashlib
## Возможности
- Получение, добавление, изменение и удаление трёх типов сущностей (видеоигр, фильмов и аудиокниг)
- Загрузка файлов (.torrent файлы, обложки, аудиофрагменты)
- Авторизация через JWT токен
- Вся конфигурация через файл .env (или переменные среды), для удобного запуска в Docker контейнере
- Лёгкое переключение между разными БД (в тестовом окружении используется SQLite, в контейнере PostgreSQL)
- Автодокументация с помощью Swagger
## Скриншоты
|![](./screenshots/swagger.png) Пример автодокументации (Swagger)|
|-|
|![](./screenshots/main.png) Пример главной страницы приложения (Frontend)|
|![](./screenshots/movie.png) Пример страницы с информацией о фильме (Frontend)|
## Запуск
### Локально
pip install -r ./requirements.txt
./main database create
fastapi dev ./main.py
## ToDo
- [ ] Dockerfile
- [ ] Добавить ссылку на общий репозиторий
- [ ] Обновить requirements.txt
- [ ] Теги жанров для сущностей
- [ ] Поиск