> [English](https://github.com/bakhirev/assayo) | [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) | [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) | [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) | [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md) | [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) | [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) | __[Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)__
# [Assayo](https://assayo.online/?ref=github&lang=ru)
Визуализация и анализ данных вашего git-репозитория. Инструмент для тимлидов и IT-аудита.
Ссылки: [демо](https://assayo.online/demo/?ref=github&lang=ru&dump=./test.txt), [online version](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/763342/), [video](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
##### 👨💻 Сотрудник может оценить новое место работы
- темп работы;
- количество переработок;
- зоны ответственности;
- объем фичей и багов;
- стиль работы коллег;
##### 👨💼 Руководитель может оценить сотрудников
- выявить бездельников;
- прикинуть объём кода;
- узнать скорость работы;
- заметить аномалии поведения;
- посмотреть динамику работы по неделям;
##### 👑 Инвестор может оценить продукт
- стоимость продукта;
- стоимость фичей;
- время на разработку;
- прогноз времени доработок;
- прогноз стоимости;
### Содержание
- [Как быстро посмотреть количество коммитов?](#link-4)
- [Как создать отчёт с помощью библиотеки?](#link-5)
- [Как объединить авторов?](#link-6)
- [Как выгрузить данные из git?](#link-7)
- [Для онлайн просмотра](#link-8)
- [Для офлайн просмотра](#link-9)
- [Если вы используете PowerShell в Windows](#link-10)
- [Как посмотреть отчёт?](#link-11)
- [Через сайт](#link-12)
- [Используя библиотеку NodeJS](#link-13)
- [Используя библиотеку PHP](#link-14)
- [Используя библиотеку Python](#link-15)
- [Используя библиотеку Ruby](#link-16)
- [Без установки библиотек](#link-17)
- [Как пересобрать файл отчёта из исходного кода?](#link-18)
- [Как посмотреть отчёт по группе микросервисов?](#link-19)
- [Как брендировать интерфейс?](#link-20)
- [Как подписывать коммиты?](#link-21)
- [Как добавить проверку текста коммита?](#link-22)
- [Используя файл commit-msg](#link-23)
- [Используя пакет pre-commit](#link-24)
- [Как автоматизировать сбор данных?](#link-25)
- [С бекендом](#link-26)
- [Без бекенда](#link-27)
- [DevOps ](#link-28)
- [Публичный сервер](#link-29)
- [Приватный сервер](#link-30)
- [Обновление Docker-образа](#link-31)
- [️ О приложении](#link-32)
- [Архитектура](#link-33)
- [Релизы, примерно, раз в полгода. Что дальше:](#link-34)
- [Как добавить или отредактировать перевод?](#link-35)
- [Пожелания, предложения, замечания](#link-36)
### 🚀 Как быстро посмотреть количество коммитов?
В корневой директории вашего проекта выполнить:
```
git shortlog -s -n -e
```
### 🏭 Как создать отчёт с помощью библиотеки?
NodeJS:
```
npx assayo
```
PHP:
```
composer require bakhirev/assayo
vendor/bin/assayo
```
Python:
```
pipx install assayo
assayo
```
Ruby:
```
gem install assayo
assayo
```
Скрипт создаст папку `./assayo` с отчётом по данному репозиторию:
```
./assayo/index.html - отчёт
./assayo/log.txt - информация полученная из git log
```
Если NodeJS у вас не установлен, тогда см. пункты «Как выгрузить данные из git?» и «Как посмотреть отчёт?»
### 🎭 Как объединить авторов?
В корневой директории вашего проекта нужно создать файл `.mailmap`.
Пример содержания файла:
```
Alex B
Alex B
Alex B
Alex B
```
Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap).
### 📤 Как выгрузить данные из git?
#### Для онлайн просмотра
В корневой директории вашего проекта выполнить:
```
git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" > log.txt
```
#### Для офлайн просмотра
```
git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > log.txt
```
Git создаст файл `log.txt`. Он содержит данные для построения отчёта. Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html`
#### Если вы используете PowerShell в Windows
По умолчанию, поток вывода не совпадает с UTF-8 и итоговый файл становится нечитаемым. Перед сохранением файла с логом вы можете изменить кодировку командой:
```
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
```
Или откройте сохраненный файл и вручную измените кодировку на UTF-8.
### 📈 Как посмотреть отчёт?
#### Через сайт
- Перейти на [сайт](https://assayo.online/)
- Нажать кнопку «[Демо](https://assayo.online/demo?ref=github&lang=ru)»
- Перетащить файл `log.txt` в окно браузера
#### Используя библиотеку NodeJS
- выполнить `npx assayo`
- открыть `./assayo/index.html`
#### Используя библиотеку PHP
- выполнить `composer require bakhirev/assayo`
- выполнить `vendor/bin/assayo`
- открыть `./assayo/index.html`
#### Используя библиотеку Python
- выполнить `pipx install assayo`
- выполнить `assayo`
- открыть `./assayo/index.html`
#### Используя библиотеку Ruby
- выполнить `gem install assayo`
- выполнить `assayo`
- открыть `./assayo/index.html`
#### Без установки библиотек
- скачать этот репозиторий
- перетащить файл `log.txt` в папку `/build`
- запустить `/build/index.html`
- или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report`
В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра.
### 🏭 Как пересобрать файл отчёта из исходного кода?
- Скачать этот репозиторий
- Выполнить `npm install`
- Выполнить `npm run build:local`
- Свежая сборка будет в папке `/build`
### 🗃️ Как посмотреть отчёт по группе микросервисов?
- Сгенерировать для каждого микросервиса файл `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.). Вы можете сделать это в ручную, или использовать модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) для автоматического сбора логов;
- См. «Как посмотреть отчёт онлайн?». На последнем шаге перетащить сразу все файлы в окно браузера.
- См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) в папку отчета (`/build`).
### 🎨 Как брендировать интерфейс?
Вы можете написать свою тему для интерфейса. Можно менять:
- **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company```
- **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий.
- **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es```
### 📝 Как подписывать коммиты?
Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например:
```
JIRA-1234 feat(profile): Added avatar for user
```
- номер задачи в таск трекере `(JIRA-1234)`
- тип работы `(feat, fix, style, refactor, test, doc и т.д.)`
- фича `(profile - раздел сайта, страница или новый функционал, одним словом)`
- какую проблему решали `(Added avatar for user)`
### 👮 Как добавить проверку текста коммита?
#### Используя файл `commit-msg`
1. Создайте файл `commit-msg` в папке `.git/hooks/`
2. Добавьте в файл следующий текст:
```
#!/usr/bin/env bash
if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((\([a-z0-9_-]{1,}\)){0,})(:\s)([a-z]{1,})" "$1"; then
echo "Need commit message like: JIRA-12 fix(profile): some text. Read Semantic Commit Messages" >&2
exit 1
fi
```
#### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Добавьте в файл `package.json` блок `commit-msg`:
```
...
"commit-msg": {
"regex": "(JIRA-[0-9]{1,5})(\\s)(feat|fix|docs|style|refactor|test|chore)((\\([a-z0-9_-]{1,}\\)){0,})(:\\s)([a-z]{1,})",
"error-message": "Need commit message like: JIRA-12 fix(profile): some text Read Semantic Commit Messages"
},
...
```
2. Выполните команду `npm install pre-commit`
### 📚 Как автоматизировать сбор данных?
#### С бекендом
- используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
#### Без бекенда
- создайте клон нужного вам репозитория;
- скопируйте в корень папку `build`;
- откройте `build/index.html` в браузере и добавьте в закладки;
- добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows);
Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку.
### 🛠️ DevOps (CI/CD)
#### Публичный сервер
Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```:
```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt
```
#### Приватный сервер
- скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- поднимите его в локальной сети;
- для просмотра отчётов используйте веб-интерфейс указывая ему адресс, где лежат данные, в URL-параметре ```dump```:
```
http://assayo_url/?dump=//you_url/some/log.txt
assayo_url - URL адресс контейнера assayo, он слушает 80 порт;
you_url - URL адресс вашего контейнера с логами git;
```
По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт.
#### Обновление Docker-образа
- собрать билд ```npm run build:docker```
- собрать образ ```docker build -t assayo .```
- визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```;
- поставить тег ```docker tag assayo bakhirev/assayo:latest```;
- запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```;
### 🛠️ ️ О приложении
#### 📐 Архитектура
1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев.
2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов.
3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными.
#### 🈯 Релизы, примерно, раз в полгода. Что дальше:
- больше советов и достижений;
- итоги года / месяца, печать отчётов;
- локализация и интернационализация;
- анализ файлов;
- разные роли для статистики (скрытие финансов);
- разработка бекенда, интеграции с другими системами;
#### 🗺️ Как добавить или отредактировать перевод?
Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```.
[Инструкция](https://github.com/firstcontributions/first-contributions)
#### 📧 Пожелания, предложения, замечания
- telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- сайт [https://assayo.online/](https://assayo.online/?ref=github&lang=ru)