Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.56 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.56 KB

QRKot

О проекте

QRKot — это веб-приложение для Благотворительного фонда поддержки котиков, созданное для упрощения процесса сбора пожертвований на различные проекты по поддержке кошачьей популяции. Платформа позволяет создавать целевые проекты, каждый из которых имеет свою цель по сбору средств. Пожертвования автоматически распределяются по активным проектам.

Основные функции

  • Управление проектами: Админы могут создавать, просматривать и закрывать проекты по сбору средств.
  • Пожертвования: Пользователи могут делать пожертвования, которые автоматически направляются в активный проект.
  • Регистрация пользователей: Пользователи могут регистрироваться, делать пожертвования и просматривать историю своих пожертвований.
  • Отчетность: Возможность формирования отчетов в Google Таблицах по закрытым проектам, сортированным по скорости сбора средств.

Технологический стек

  • Python
  • FastAPI
  • Aiogoogle
  • SQLAlchemy
  • SQLite
  • PyJWT

Документация API

API обеспечивает управление проектами и пожертвованиями с помощью HTTP-запросов. Для подробной документации по API см. спецификацию openapi.json.

Начало работы

Для локального запуска QRKot выполните следующие шаги:

  1. Клонирование репозитория и установка зависимостей:

    git clone [email protected]:qwertttyyy/QRkot.git 
    cd QRKot
    pip install -r requirements.txt
  2. Инициализация базы данных:

    alembic upgrade head
  3. Запуск сервера FastAPI:

    uvicorn main:app --reload

Теперь приложение QRKot доступно по адресу http://localhost:8000.