FSPodium

Платформа для координации между офисом Федерации спортивного программирования ДНР и её структурными подразделениями

Демо

Здесь будут скриншоты работы проекта, возможно даже видео.

Особенности реализации

• веб-приложение:
  • авторизация пользователей с проверкой почты
  • поддержка ролей центрального и региональных представительств
  • возможность подачи заявки на регистрацию аккаунта представительства и добавление соревнований
  • просмотр и управление всеми типами заявок центром
  • одобренные центром события отображаются в удобном календаре
  • вывод аналитической информации
  • уведомления о новых заявках и обращениях, а также изменении их статуса
  • изменение публичной контактной информации
• Telegram-бот:
  • вход в учётную запись через веб-приложение
  • один из способов получения уведомлений
  • канал связи между центром и регионами
  • получение публичных данных о представительстве
  • получение справочной информации
• генератор данных:
  • позволяет генерировать синтетические данные, приближенные к реальным
  • позволяет парсить TXT и CSV датасеты
  • сохраняет сгенерированные данные в PostgreSQL
• парсер отчётов:
  • позволяет распознавать результаты соревнований из файлов формата DOCX
  • полностью поддерживается формат отчётов ФСП ДНР

Архитектура

Проект состоит из микросервисов, предназначенных для развёртывания в Docker:

• веб-приложение
• ...

В планах

• дополнительные варианты отображения контента
• перенос основных возможностей веб-приложения в Telegram-бот
• составление календарного плана и отчётов о соревнованиях в удобном интерфейсе
• единый шаблон генерации выходных документов для всех регионов
• упразднение парсера отчётов после обеспечения полного перехода всех представительств на FSPodium
• расширение целевой аудитории платформы: тренеры, спортсмены, кейсодержатели
• общий рейтинг спортсменов на платформе с историей соревнований и наградами

Установка

Note

Мы отказались от использования git submodules и git subtree из-за периодически возникающей путаницы при отслеживании изменений в монорепозиториях. Данный репозиторий представляет собой единую точку для работы с проектом, лишённую этих недостатков.

0. Клонируйте репозиторий и перейдите в его папку.
1. Клонируйте репозитории сервисов, входящих в состав проекта по SSH (рекомендуется):

git clone git@github.com:code-418-dpr/FSPodium-web.git services/FSPodium-web

или по HTTPS:

git clone https://github.com/code-418-dpr/FSPodium-web.git services/FSPodium-web

После этого вы можете вносить изменения в каждый из сервисов по-отдельности (в соответствии с инструкциями, описанными в соответствующих README).

Запуск

0. Установите проект по инструкции выше.
1. Создайте файл .env на основе .env.template и настройте все описанные там параметры.
2. Установите Docker.
3. Теперь запускать проект можно командой:

docker compose up -d --build