tvules / qrkot

QRKot — Благотворительный фонд поддержки котиков

QRKot

Содержание

• Описание
  • Возможности
  • Технологии
• Начало работы
  • Зависимости
  • Установка
  • Локальный запуск
• Использование
• Автор проекта

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

🔥 Возможности

• В Фонде QRKot может быть открыто несколько целевых проектов.
• Каждый пользователь может сделать пожертвование и сопроводить его комментарием.
• Пожертвования в проекты поступают по принципу First In, First Out.

Технологии

⚙ Начало Работы

Чтобы запустить локальную копию проекта, следуй инструкциям ниже.

⚠ Зависимости

• Python 3.7+

Установка

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

   git clone https://github.com/tvules/QRKot.git
   cd QRKot

Локальный Запуск (Development)

1. Установи зависимости проекта

   pip install -r requirements.txt

2. В корне проекта создай .env файл

   SECRET="<секретный ключ>"

   *Секретный ключ можно сгенерировать тут

3. Запусти локальный сервер

   uvicorn app.main:app

   После запуска, проект будет доступен по адресу http://localhost:8000/

👀 Использование

Swagger UI доступен по адресу http://localhost:8000/docs.

Там ты найдешь полную документацию к API, а также сможешь сделать запрос на сервер.

---

Автор проекта: Ilya Petrukhin