mirror of
https://github.com/StepanovPlaton/torrent_backend.git
synced 2026-04-03 20:30:38 +04:00
Add readme, screenshots and small fixes
This commit is contained in:
42
README.md
Normal file
42
README.md
Normal 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
|
||||
|
||||
## Скриншоты
|
||||
|
||||
| Пример автодокументации (Swagger)|
|
||||
|-|
|
||||
| Пример главной страницы приложения (Frontend)|
|
||||
| Пример страницы с информацией о фильме (Frontend)|
|
||||
|
||||
## Запуск
|
||||
### Локально
|
||||
pip install -r ./requirements.txt
|
||||
./main database create
|
||||
fastapi dev ./main.py
|
||||
|
||||
## ToDo
|
||||
- [ ] Dockerfile
|
||||
- [ ] Добавить ссылку на общий репозиторий
|
||||
- [ ] Обновить requirements.txt
|
||||
- [ ] Теги жанров для сущностей
|
||||
- [ ] Поиск
|
||||
Reference in New Issue
Block a user