Funtech_backend

Проект развернут на сервере:
https://funtech-team8.duckdns.org/api/v1
https://funtech-team8.duckdns.org/api/v2

Администрирование приложения может быть осуществлено:

• через админ панель по адресу https://funtech-team8.duckdns.org/admin
  Учетные данные для входа в админ-зону
• через Swagger доступный по адресу https://funtech-team8.duckdns.org/docs

Мониторинг фоновых задач Celery осуществляется по адресу: http://funtech-team8.duckdns.org:5555
Для активации фоновых задач необходимо выполнить GET-запрос к эндпойнтам:

• специализаций (https://funtech-team8.duckdns.org/api/v2/specializations/?theme=3)
• стека (https://funtech-team8.duckdns.org/api/v2/stack/?specialization=4)

Техническая документация:

• Redoc доступен по адресу https://funtech-team8.duckdns.org/redoc
• Скачать yaml-файл можно по адресу https://funtech-team8.duckdns.org/schema

Оглавление

• Технологии
• Установка приложения
• Запуск тестов
• Запуск приложения
• Удаление приложения
• Авторы

Технологии

Подробнее

⬆️Оглавление

Установка приложения:

Предварительные условия

Предполагается, что пользователь установил Docker и Docker Compose на локальной машине. Проверить наличие можно выполнив команды:

    docker --version && docker-compose --version

!!! обязательно выполнить команду: иначе файл start.sh при клонировании будет бракован:

    git config --global core.autocrlf false

Клонируйте репозиторий с GitHub и введите данные для переменных окружения (значения даны для примера, но их можно оставить):

    git clone https://github.com/Team88888/Funtech_backend.git
    cd Funtech_backend
    cp env_example .env
    nano .env

⬆️Оглавление

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

(Виртуальное окружение) Codecov=97%

1. Создайте и активируйте виртуальное окружение и установите необходимые зависимости::

   • Если у вас Linux/macOS

    python -m venv venv && source venv/bin/activate
    python -m pip install --upgrade pip && pip install -r requirements/test.requirements.txt

   • Если у вас Windows

    python -m venv venv && source venv/Scripts/activate
    python -m pip install --upgrade pip && pip install -r requirements/test.requirements.txt

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

    python funtech_proj/manage.py makemigrations
    pytest --cov --cov-config=.coveragerc

⬆️Оглавление

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

(Docker)

1. Из корневой директории проекта выполните команду:

    docker compose -f infra/local/docker-compose.yml --env-file .env up -d --build

Проект будет развернут в docker-контейнерах по адресу
http://localhost/api/v1
http://localhost/api/v2

Администрирование приложения может быть осуществлено:

• через админ панель по адресу http://localhost/admin
• через Swagger доступный по адресу http://localhost/docs

Мониторинг фоновых задач Celery осуществляется по адресу: http://localhost:5555
Для активации фоновых задач необходимо выполнить GET-запрос к эндпойнтам:

• специализаций (http://localhost/api/v2/specializations/?theme=3)
• стека (http://localhost/api/v2/stack/?specialization=4)

Техническая документация:

• Redoc доступен по адресу http://localhost/redoc
• Скачать yaml-файл можно по адресу http://localhost/schema

Учетные данные для входа в админ-зону:

• login: adm@adm.com
• password: admpw

2. Остановить docker и удалить контейнеры можно командой из корневой директории проекта:

    docker compose -f infra/local/docker-compose.yml --env-file .env down

Если также необходимо удалить том базы данных:

    docker compose -f infra/local/docker-compose.yml --env-file .env down -v && docker system prune -f

⬆️Оглавление

Удаление приложения:

Из корневой директории проекта выполните команду:

    cd .. && rm -fr Funtech_backend && deactivate

⬆️Оглавление

Авторы (в алфавитном порядке):

Аустер Яков
Варивода Георгий
Проскуряков Алексей

⬆️В начало