FastAPI app

Этот проект представляет собой resful api, разработанный согласно заданию из файла task.md.

Требования

• Python 3.9 (для запуска без Docker)
• Docker (для запуска через Docker)

Содержимое проекта

• Dockerfile - файл конфигурации Docker
• requirements.txt - файл с зависимостями Python
• app/ - директория с кодом проекта
• README.MD - этот файл с инструкцией
• app/configs.json - файл с настройками генерации JWT-токенов

Клонируйте репозиторий

git clone https://github.com/Sapdotten/gooddelo_case.git
cd ./gooddelo_case

Настройте переменные окружения перед запуском

Необходимо создать файл .env в корневой директории проекта, где нужно указать следующие переменные окружения:

• JWT_SECRET - ключ для генерации JWT-токенов
• SQL_USER - имя пользователя PostgreSQL
• SQL_PASSWORD - пароль для пользователя PostgreSQL
• SQL_HOSTNAME - хост базы данных (с указанием порта) PostgreSQL
• SQL_DATABASE_NAME - имя базы данных PostgreSQL
• REDIS_HOST - хост базы данных Redis

Дополнительно, но не обязательно, можно указать:

• REDIS_USER - имя пользователя базы данных Redis
• REDIS_PASSWORD - пароль пользователя базы данных Redis
• REDIS_DB - номер базы данных Redis

Инструкция по запуску с использованием Docker

1. Убедитесь в том, что есть файл .env

2. Соберите Docker-образ

docker build -t my-app .

3. Запустите контейнер

docker run -p 5000:5000 my-app

4. Пользуйтесь

API работает по адресу http://0.0.0.0:5000

Документация: http://0.0.0.0:5000/docs

Инструкция по запуску без использования Docker

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

python3 -m venv venv
source venv/bin/activate  
# Для Windows используйте `venv\Scripts\activate.bat`

2. Установите зависимости

pip install -r requirements.txt

3. Убедитесь в том, что есть файл .env

4. Запустите приложение

uvicorn app.main:app --host 0.0.0.0 --port 5000 --reload

5. Пользуйтесь

API работает по адресу http://0.0.0.0:5000

Документация: http://0.0.0.0:5000/docs