Hexlet Friends

Сервис для отслеживания вклада участников сообщества Хекслет в его open-source проекты на GitHub.

Вклад — issues, pull requests, commits, comments.

Установка

Установить make. Для работы с Poetry (без Docker) установить Poetry. Для работы с Docker установить Docker Engine и Docker Compose.

1. Склонировать репозиторий

git clone https://github.com/Hexlet/hexlet-friends
cd hexlet-friends

2. Установить зависимости

Poetry

make install

Docker

make .env
docker-compose build

3. Задать значения переменным окружения в .env

GITHUB_AUTH_TOKEN — Personal access token из настроек GitHub. Используется для запросов данных у GitHub.

Значения для GITHUB_WEBHOOK_TOKEN и SECRET_KEY можно сгенерировать командой make secretkey или придумать.

Переменные GITHUB_AUTH_CLIENT_ID и GITHUB_AUTH_CLIENT_SECRET нужны для авторизации через GitHub; получить значения для них можно создав OAuth application. В поле Authorization callback URL нужно указать http://localhost:8000/auth/github/login.

При работе с Poetry можно использовать SQLite, добавив DB_ENGINE=SQLite. Если установлена PostgreSQL, задать значения соответствующим переменным POSTGRES.

4. Завершить настройку

Poetry

make setup

Docker

docker-compose run --rm django make setup

Наполнение базы данных

Получить данные можно через интерфейс панели администрирования либо выполнив описанные команды. Для Docker перед этими командами надо добавить docker-compose run --rm django.

По именам организаций:

make sync ARGS='ORG [ORG ...]'

По полным именам репозиториев (org_name/repo_name):

make sync ARGS='--repo REPO [REPO ...]'

Последующее обновление данных:

make sync

Запуск сервера для разработки

Poetry

make start

Docker

docker-compose up

Локализация текста

Установить gettext (при работе с Poetry).

1. Выполнить make transprepare — подготовка файлов *.po в директории locale/ru/LC_MESSAGES.
2. Внести изменения в эти файлы.
3. Выполнить make transcompile.