BrainForces

Суть проекта

Создание сайта для проведения онлайн соревновательных викторин

Установка и запуск

Клонировать репозиторий

git clone https://github.com/fivan999/BrainForces

Конфигурация

Создайте .env файл в папке brainforces.

В нем нужно указать значения:

• SECRET_KEY (ваш секретный ключ, по умолчанию - default)
  
• DEBUG (включать ли режим дебага, по умолчанию - True)
  
• ALLOWED_HOSTS (если включен DEBUG, он ['*'], иначе по умолчанию - 127.0.0.1)
  
• INTERNAL_IPS (для debug_toolbar, по умолчанию - 127.0.0.1)
  
• EMAIL (с какой почты вы будете отправлять письмо пользователю)
  
• LOGIN_ATTEMPTS (количество попыток входа, после которого аккаунт становится неактивным)
  
• USER_IS_ACTIVE (активный ли пользователь сразу после регистрации)
  
• USE_POSTGRES (использовать ли базу данных PostgreSQL, по умолчанию - False) Также нужно настроить базу данных PostgreSQL, если вы ее используете
• DB_NAME (имя базы данных)
• DB_HOST (хост базы данных)
• DB_PORT (порт базы данных)
• DB_USER (имя пользователя на сервере)
• DB_PASS (пароль от пользователя) Пример .env файла - .env.example

Запуск с помощью Docker

Скачайте Docker: https://www.docker.com/
Запустите Docker
Если вы используете опцию USE_POSTGRES=True, то DB_HOST и DB_PORT можно не указывать
В терминале:

docker-compose --env-file brainforces/.env build

docker-compose --env-file brainforces/.env run --rm web-app sh -c "python manage.py migrate"

docker-compose --env-file brainforces/.env up 

Запуск без Docker

Установка зависимостей

Создайте виртуальное окружение и активируйте его
Для Windows:

python -m venv venv
venv\Scripts\activate

Для Linux:

python3 -m venv venv
source venv/bin/activate

Установите нужные зависимости

Для запуска

pip install -r requirements/base.txt

Для разработки

pip install -r requirements/dev.txt

Для тестов

pip install -r requirements/test.txt

Запуск

Сделайте миграции:

python brainforces/manage.py migrate

Запустите проект:

python brainforces/manage.py runserver

Техническое задание

В общем: cоздаем сайт для проведения онлайн соревновательных викторин

Первый этап:

• Создать пользователя
• Создать администратора
• Создать сущности вопрос и викторина
• Для начала админ может создавать вопросы и викторины с помощью админ панели
• У викторины может быть три статуса:
  • Не начата: регистрация на викторину
  • Идет: пользователи отправляют решения (по одному на вопрос), строится табличка лидеров
  • Закончена: пользователям начисляется рейтинг, вопросы отправляются в архив, вопросы можно сдавать, пока не ответишь правильно
• Примечание: викторину создаем пока что без таймера, админ сам меняет ее статусы
• Профиль пользователя
  • Базовая информация (почта, ник, имя, фамилия, аватарка)
  • Рейтинг (можно добавить звание как на кфе в зависимости от рейтинга)
  • В каких соревнованиях участвовал (отдельная страничка)
• Главная страничка с доступными соревнованиями (добавим пагинацию)
• Страничка с архивными вопросами (также пагинация)
• Страничка с активной викториной (переключение между вопросами)
• Страничка с таблицей лидеров (пагинация)
• Страничка с конкретным вопросом

Второй этап:

• Добавить админам возможность создавать викторину не заходя в админ-панель
• Добавить время начала и продолжительность викторины
• Добавить список лидеров

Третий этап (возможно не успеем)

• Добавить сущность организации
  • Организация - это некая группа в нашем приложении.
  • Пользователь может создать организацию, став ее админом
  • Админ может пригласить других пользователей в организацию. Например: Данила решил создать организацию Джанго весна 23 и пригласить в нее всех джангистов.
  • Пользователь в своем профиле может принять приглашение от организации (отдельная страница)
  • И самое главное: админ организации может создавать соревнования от лица организации.
• Админ организации может посмотреть пользователей, зарегистрированных на соревнование.
• Фильтрация активных викторин по организациям

Это мы точно вряд ли успеем, но идея хорошая

• Добавить динамическую генерацию форм для конкретного соревнования. Пояснение: пусть организация при создании соревнования хочет узнать от пользователя какие-то нужные ей данные. Например, Данила решит отправить мерч победителю викторины. Для этого ему нужны доп данные пользователя, например адрес. Эти данные сайт не будет сохранять в модели пользователя, но они будут сохраняться как дополнительные у организатора соревнования.

Детали

• База данных - PostgreSQL

Правила для разработчиков

• Тайпинг
• Одинарные кавычки (дефолт по флейку)
• У функций и классов докстринги, не обязательно документировать каждый аргумент, достаточно краткого описания функции
• Комментарии тоже нужны, но все подряд не комментировать, только там, где нужно)
• Нормальные и более-менее осмысленные названия классов, функций, переменных
• Отступы в шаблонах - 2 пробела. было бы славно поставить плагин djlint, чтобы он проверял шаблоны за вас, постарайтесь максимально исправлять его исью также полезный плагин для шаблонов - django(6,2 м. скачиваний)
• Модель ветвления такая же (ветка main, от нее ветки-фичи)
• Давать краткие и понятные комментарии к коммитам
• У полей моделей и форм обязательно писать verbose_name. help_text - очень желательно
• Для изменения виджетов формы не прописываем их в форме. Используем модуль django-widget-tweaks в шаблоне
• Все вьюхи с помощью CBV
• На функционал стараемся писать тесты
• Все тесты делаем с помощью джанговских юниттестов
• Перед коммитом проверяем, всё ли у нас хорошо
  • Проверяем линтинг с помощью flake8 и black
  • Порядок импортов с помощью isort
  • Тайпинг с помощью mypy
  • Запускаем тесты