Проект сервис Donations.

Оглавление

1. Описание проекта
2. Используемые технологии
3. Архитектура проекта
4. Как развернуть проект локально?
5. Авторы проекта

---

Описание проекта:

Проект, позволяющий собирать пожертвования на различные целевые проекты.

---

Используемые технологии

---

Архитектура проекта

Директория	Описание
alembic	Содержит миграции проекта
app	Файлы проекта FastAPI
test	Директория с тестами проекта

---

Как развернуть проект локально?

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

  git clone https://github.com/FakaFakaYeah/donation_project.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
  

• Наполнить env файл
  В проекте создан шаблон env файла, добавьте вначале точку, заполните значения

  DATABASE_URL=sqlite+aiosqlite:///./fastapi.db
  TITLE=Благотворительного фонда поддержки котиков QRKot
  DESCRIPTION=Фонд собирает пожертвования на различные целевые проекты: на медицинское обслуживание нуждающихся хвостатых, на обустройство кошачьей колонии в подвале, на корм оставшимся без попечения кошкам — на любые цели, связанные с поддержкой кошачьей популяции.
  SECRET= Ваш секретный ключ
  

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

  alembic upgrade head
  

• Запустить проект

  uvicorn app.main:app --reload
  

• Проект будет доступен по следующему адресу:

  http://127.0.0.1:8000 
  

• Документация проекта со всеми описаниями и эндпоинтами доступна по адресу:

  http://127.0.0.1:8000/docs
  

---

Авторы проекта:

Смирнов Степан