cnlis / cat_charity_fund Goto Github PK

Проект асинхронного API для создания благотворительных проектов и сбора пожертвований на них с поддержкой авторизации и аутентификации.

• Python 3.9
• FastAPI 0.78.0
• FastAPI-Users 10.0.4
• SQLAlchemy 1.4.36 (с alembic 1.7.7)

Клонировать репозиторий и перейти в него в командной строке:

https://github.com/cnlis/cat_charity_fund.git
cd cat_charity_fund

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

python3 -m venv venv

• Если у вас Linux/MacOS

  source venv/bin/activate
  

• Если у вас Windows

  source venv/scripts/activate
  

Установить зависимости из файла requirements.txt:

python3 -m pip install --upgrade pip
pip install -r requirements.txt

Выполнить миграции

alembic upgrade head

Создать в коорне проекта файл .env и заполнить его следующей информацией

APP_TITLE=[название сервиса]
APP_DESCRIPTION=[описание сервиса]
DATABASE_URL=[строка подключения к базе данных]
SECRET=[секретный ключ]
FIRST_SUPERUSER_EMAIL=[почта первого суперпользователя]
FIRST_SUPERUSER_PASSWORD=[пароль первого суперпользователя]

uvicorn app.main:app --reload

Полная спецификация к API приведена в файле openapi.json или по эндпоинту /docs на запущенном сервере в формате Swagger

Автор: Кирилл Лисицынский (https://github.com/cnlis/)