QRkot - это API сервис для сбора пожертвований в благотворительные проекты. В проекте реализованы функции создания благотворительны проектов, внесения пожертвований, автоматическое их распределение по открытым проектам в порядке очереди (First In, First Out). Настроена системы аутентификации и авторизации пользователей. При запуске проекта автоматически создается суперюзер.
- Клонировать репозиторий и перейти в него в командной строке:
git clone [email protected]:elityaev/cat_charity_fund.git
- Создать и активировать виртуальное окружение, обновить библиотеку pip, установить зависимости:
python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
- В корневой директории создать и заполнить env-файл по следующему шаблону:
APP_TITLE=Благотворительный фонд поддержки котиков QRKot
DATABASE_URL=sqlite+aiosqlite:///./<название базы данных>.db
SECRET=<секретное слово>
FIRST_SUPERUSER_EMAIL=<email суперюзера>
FIRST_SUPERUSER_PASSWORD=<пароль суперюзера>
- Применить миграции для создания БД
alembic upgrade head
- Запустить локальный сервер
uvicorn app.main:app --reload
Документация к API будет доступна по следующим адресам:
http://127.0.0.1:8000/docs - Swagger
http://127.0.0.1:8000/docs - ReDoc
Литяев Евгений