Skip to content

This project is a referral system built with FastAPI, SQLAlchemy, Pydantic, etc.

Notifications You must be signed in to change notification settings

kolenkoal/fastapi_referral_system

Repository files navigation

Реферальная система

Запуск приложения

Для запуска FastAPI используется установленный Docker на компьютере.

  1. Склонируйте репозиторий
    git clone <URL репозитория>
    cd <название папки проекта>
  1. Переименуйте .env-example файл в .env и вставьте туда недостающие данные. JWT_SECRET_KEY может быть любым, а для корректного использования верификации email необходим API ключ с сайта hunter.io. Его нужно ввести в EMAIL_VERIFIER_API_KEY.

  2. Выполните команду для запуска контейнеров:

    docker compose up --build
  3. Откройте ваш браузер и перейдите по адресу http://127.0.0.1:8000/docs для доступа к приложению.

  4. Вам откроется интерфейс SwaggerUI, где можно исследовать все написанные routes.

  5. По окончании работы, остановите контейнеры:

    docker compose down

About

This project is a referral system built with FastAPI, SQLAlchemy, Pydantic, etc.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published