Yandex FunTech IT Meetups API

О проекте

Сервис для участников it мероприятий.

https://meetup.ddns.net/

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

Команда:

Product manager
- Морозов Алексей (TG) @alxmorozov
Project manager
- Петелина Александра (TG) @Picha_pich
Business analytics
- Павлова Мария (TG @MariaPavlova111)
System analytics
- Джага Артем (TG @purple_SU)
- Титов Владислав (TG @Vladislav7)
- Дунаевский Евгений (TG @Evgeniy_Dunaevskiy)
Designers
- Суслов Андрей (TG @s_aandrei)
- Черепова Александра (TG @Cherepova_alex)
Frontend
- Мытников Дмитрий (TG @Dmitry_Myt)
- Боднюк Анастасия (TG @chill_peppa)
Backend
- Лашков Павел (TG @hutjinator)
- Бобков Константин (TG @Bi_oKey)
- Сидельцева Мария (TG @sub_mar)

Документация

Документация сгенерирована при помощи drf-spectacular.

Swagger

Redoc

Стек технологий

Установка зависимостей для локального разворачивания проекта

Склонируйте репозиторий:

  git clone git@github.com:yandex-funtech-it-events/backend.git
  cd backend

В корневой директории создайте .env файл:

  cd backend
  touch .env

Заполните по примеру своими значениями: скопируйте этот файл

Запуск

Запустите контейнеры с проектом следующей командой:

  docker compose up -d

Выполните миграции:

  docker compose exec backend python manage.py makemigrations
  docker compose exec backend python manage.py migrate

Создайте суперпользователя:

  docker compose exec backend python manage.py createsuperuser

Зайти в админ-панель: Admin

Посмотреть документацию: Swagger

CI/CD

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

при пуше в любую ветку запускаются тесты
при мёрдже PR в ветки develop проект запускается на удалённом сервере
при мёрдже PR в ветку main проект запускается на удалённом сервере

Для корректной работы CI/CD необходимо создать секретные переменные репозитория (Repository secrets):

DOCKER_USERNAME=<docker_username>
DOCKER_PASSWORD=<docker_password>

SERVER_HOST=<server_pub_ip>
SERVER_USER=<username>

SSH_KEY=<--BEGIN OPENSSH PRIVATE KEY--...--END OPENSSH PRIVATE KEY--> # cat ~/.ssh/id_rsa
SSH_PASSPHRASE=<ssh key passphrase>

hutji/IT-meetups

Yandex FunTech IT Meetups API

Оглавление