/fast-api-judgmentPDF

Primary LanguagePythonMIT LicenseMIT

Проект Setup Guide

1. Клонирование репозитория

Сначала клонируйте репозиторий на свой локальный компьютер:

git clone https://github.com/Popachka/fast-api-judgmentPDF.git
cd fast-api-judgmentPDF

2. Создание виртуального окружения

Создайте виртуальное окружение в папке проекта:

python -m venv venv

3. Активация виртуального окружения

Windows

cd venv\Scripts
activate

macOS и Linux

source venv/bin/activate

4. Установка зависимостей

Установите все необходимые зависимости из файла requirements.txt:

pip install -r requirements.txt

5. Управление миграциями базы данных

Создание новой миграции

Для создания новой миграции на основе изменений в моделях используйте следующую команду:

docker-compose run app alembic revision --autogenerate -m "New Migration"
docker-compose run app alembic upgrade head

6. Сборка и запуск Docker-контейнеров

Сборка контейнеров

Соберите Docker-контейнеры:

docker-compose build

Запуск контейнеров

Запустите Docker-контейнеры:

docker-compose up

После выполнения этих шагов ваш проект должен быть готов к работе.

Использовани приложения

После того, как вы запустите контейнер - перейдите на http://localhost:8000/. Это страница с основным приложением

Если вы хотите посмотреть, что находится в базе данных по адресу http://localhost:5050/ будет pgAdmin.

Сделайте подключение (все настройки в .env) к базе и можете мониторить её через админку

Документация API по адрессу - http://localhost:8000/docs/

Примечания

Удостовертесь, что у вас скачен Docker Desktop