ilyavasilevsky47 / qrkot_spreadsheets

QRKot — это API для Благотворительного фонда поддержки котиков.

QRKot

QRKot — это API для Благотворительного фонда поддержки котиков.

Фонд собирает пожертвования на различные проекты, включая медицинское обслуживание, обустройство колоний в подвалах, корм для кошек, оставшихся без опеки, и любые другие цели, связанные с поддержанием популяции кошек.

Основные возможности:

• В Фонде могут быть запущены несколько проектов, каждый из которых имеет название, описание и сумму сбора. Когда сумма собрана, проект закрывается.
• Пользователи могут делать пожертвования на любую сумму, добавляя при желании комментарий. Пожертвования идут в общий фонд и распределяются по проектам до сбора полной суммы. Если пожертвовано больше, чем требуется, остаток сохраняется для следующего проекта. Новые средства автоматически инвестируются в новый проект при его запуске.
• Администраторы сайта создают проекты и управляют ими. Пользователи видят полный список проектов и их статус. Зарегистрированные пользователи также могут отправлять пожертвования и отслеживать свои предыдущие взносы.

Дополнительная возможность:

• Возможность создавать отчеты о скорости закрытия проектов в Google Таблицах.

Запуск проекта:

1. Клонируем проект.

git clone [email protected]:IlyaVasilevsky47/QRkot_spreadsheets.git

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

python -m venv venv
source venv/scripts/activate

3. Обновляем менеджер пакетов pip и устанавливаем зависимости из файла requirements.txt.

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

4. Создаем файл .env и заполняем его.

DATABASE_URL=sqlite+aiosqlite:///./cat-foundation.db

5. Создаем базу данных.

alembic upgrade head

6. Запускаем проект.

uvicorn app.main:app

Пример запроса:

Аутентификация (POST): https://cors.redoc.ly/auth/register

Входные данные:

{
  "email": "[email protected]",
  "password": "string",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false
}

Полученные данные:

{
  "id": null,
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false
}

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

• ReDoc

Автор:

• Василевский И.А.
• GitHub
• Почта
• Вконтакте

Технический стек

• Python 3.9.0
• sqlalchemy 1.4.36
• FastAPI 0.78.0
• FastAPI-Users 10.0.4
• Uvicorn 0.17.6
• aiosqlite 0.17.0
• Aiogoogle 5.5.0
• google-auth 2.23.2