diff --git a/README.md b/README.md index 5a76b4e..f2f6575 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,93 @@ -# [Assayo](https://assayo.jp/) +> The [main documentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) is in Russian. This is a translation. It may contain errors. If you a native speaker, you can help improve this translation. Thanks! -Визуализация и анализ данных вашего git-репозитория ([демо](https://assayo.jp/demo/?dump=./test.txt)). +> - [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) +> - [English](https://github.com/bakhirev/assayo) -##### Сотрудник может оценить новое место работы -- темп работы; -- количество переработок; -- зоны ответственности; -- объем фичей и багов; -- стиль работы коллег; +# [Assayo](https://assayo.jp/?ref=github&lang=en) -##### Руководитель может оценить сотрудников -- выявить бездельников; -- прикинуть объём кода; -- узнать скорость работы; -- заметить аномалии поведения; -- посмотреть динамику работы по неделям; +Visualization and analysis of your git repository data ([demo](https://assayo.jp/demo/?ref=github&lang=en&dump=./test.txt)). -##### Инвестор может оценить продукт -- стоимость продукта; -- стоимость фичей; -- время на разработку; -- прогноз времени доработок; -- прогноз стоимости; +##### Employee can evaluate new workplace +- work pace; +- number of extra hours worked; +- areas of responsibility; +- volume of features and bugs; +- working style of colleagues; -### Как быстро посмотреть количество коммитов? +##### Manager can evaluate employees +- identify slackers; +- estimate the amount of code; +- learn the work speed; +- notice behavioral anomalies; +- see the dynamics of work by week; -В корневой директории вашего проекта выполнить: +##### Investor can evaluate product +- product cost; +- cost of features; +- development time; +- forecast of rework time; +- forecast cost; + +### How to quickly view the number of commits? + +In the root directory of your project, run: ``` git shortlog -s -n -e ``` -### Как объединить авторов? -В корневой директории вашего проекта нужно создать файл `.mailmap`. -Пример содержания файла: +### How to concat authors? +In the root directory of your project, you need to create a `.mailmap` file. +Example of the contents of the file: ``` Alex B Alex B Alex B Alex B ``` -Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap). +Read more about the format of this file you can [here](https://git-scm.com/docs/gitmailmap). -### Как выгрузить данные из git? +### How to export data from git? -#### Для онлайн просмотра -В корневой директории вашего проекта выполнить: +#### For online viewing +In the root directory of your project run: ``` git --no-pager log --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" > log.txt ``` -#### Для офлайн просмотра +#### For offline viewing ``` git --no-pager log --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt ``` -Git создаст файл `log.txt`. -Он содержит данные для построения отчёта. +Git will create a file `log.txt`. +This file contains data for show a report. -Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html` +The difference between the online and offline format is the presence of a wrapper for strings. The offline format will be pulled up like a `js` file if you just opened `/build/index.html ` -### Как посмотреть отчёт онлайн? +### How to view the report online? -- Перейти на [сайт](https://assayo.jp/) -- Нажать кнопку «[Демо](https://assayo.jp/demo)» -- Перетащить файл `log.txt` в окно браузера +- Go to the [website](https://assayo.jp/) +- Click the “[Demo](https://assayo.jp/demo)” button. +- Drag the `log.txt` file into the browser window. -### Как посмотреть отчёт офлайн? -- Скачать этот репозиторий -- Перетащить файл `log.txt` в папку `/build` -- Запустить `/build/index.html` -- Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report` +### How to view the report offline? +- Download this repository. +- Drag the `log.txt` file to the `/build` folder. +- Run `/build/index.html` +- Or drag the `/build` folder to your repository (where the `log.txt` is located). You can change the name. For example, from `/build` to `/report`. В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра. -### Как пересобрать билд отчёта? -- Скачать этот репозиторий -- Выполнить `npm install` -- Выполнить `npm run build` -- Свежая сборка будет в папке `/build` +### How to rebuild the report build? +- Download this repository +- Run `npm install` +- Run `npm run build` +- The new build will be in the `/build` folder -### Как посмотреть отчёт по группе микросервисов? -- Сгенерировать для каждого микросервиса `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) -- См. «Как посмотреть отчёт онлайн?». На последнем шаге перетащить сразу все файлы в окно браузера. -- См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) в папку отчета (`/build`). +### How to view a report on a group of microservices? +- Generate for each microservice `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) +- See “How to view an online report?”. At the last step, drag all the files at once into the browser window. +- See “How to see a report offline?”. At the second step, drag all microservice files (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) to the report folder (`/build`). -### Как брендировать интерфейс? +### How to brand the interface? Вы можете написать свою тему для интерфейса. Можно менять: - **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company``` - **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий. diff --git a/documents/RU.md b/documents/RU.md new file mode 100644 index 0000000..4fc5733 --- /dev/null +++ b/documents/RU.md @@ -0,0 +1,161 @@ +> - [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) +> - [English](https://github.com/bakhirev/assayo) + +# [Assayo](https://assayo.jp/?ref=github&lang=ru) + +Визуализация и анализ данных вашего git-репозитория ([демо](https://assayo.jp/demo/?dump=./test.txt)). + +##### Сотрудник может оценить новое место работы +- темп работы; +- количество переработок; +- зоны ответственности; +- объем фичей и багов; +- стиль работы коллег; + +##### Руководитель может оценить сотрудников +- выявить бездельников; +- прикинуть объём кода; +- узнать скорость работы; +- заметить аномалии поведения; +- посмотреть динамику работы по неделям; + +##### Инвестор может оценить продукт +- стоимость продукта; +- стоимость фичей; +- время на разработку; +- прогноз времени доработок; +- прогноз стоимости; + +### Как быстро посмотреть количество коммитов? + +В корневой директории вашего проекта выполнить: +``` +git shortlog -s -n -e +``` +### Как объединить авторов? +В корневой директории вашего проекта нужно создать файл `.mailmap`. +Пример содержания файла: +``` +Alex B +Alex B +Alex B +Alex B +``` +Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap). + +### Как выгрузить данные из git? + +#### Для онлайн просмотра +В корневой директории вашего проекта выполнить: +``` +git --no-pager log --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" > log.txt +``` +#### Для офлайн просмотра + +``` +git --no-pager log --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt +``` +Git создаст файл `log.txt`. +Он содержит данные для построения отчёта. + +Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html` + +### Как посмотреть отчёт онлайн? + +- Перейти на [сайт](https://assayo.jp/) +- Нажать кнопку «[Демо](https://assayo.jp/demo)» +- Перетащить файл `log.txt` в окно браузера + +### Как посмотреть отчёт офлайн? +- Скачать этот репозиторий +- Перетащить файл `log.txt` в папку `/build` +- Запустить `/build/index.html` +- Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report` + +В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра. + +### Как пересобрать билд отчёта? +- Скачать этот репозиторий +- Выполнить `npm install` +- Выполнить `npm run build` +- Свежая сборка будет в папке `/build` + +### Как посмотреть отчёт по группе микросервисов? +- Сгенерировать для каждого микросервиса `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) +- См. «Как посмотреть отчёт онлайн?». На последнем шаге перетащить сразу все файлы в окно браузера. +- См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`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``` + +### Как добавить или отредактировать перевод? + +Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/``` и создать Pull Request. + +### Как подписывать коммиты? + +Следуйте практике [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)` + +### Как автоматизировать сбор данных? + +#### Без бекенда +- создайте клон нужного вам репозитория; +- скопируйте в корень папку `build`; +- откройте `build/index.html` в браузере и добавьте в закладки; +- добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows); + +Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку. + +### DevOps (CI/CD) + +#### Публичный сервер + +Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.jp/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```: +``` +https://assayo.jp/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 build -t assayo .``` +- визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```; +- поставить тег ```docker tag IMAGE_ID bakhirev/assayo:latest```; +- запушить образ в Docker Hub + +### Релизы, примерно, раз в полгода. Что дальше: + +- больше советов и достижений; +- итоги года / месяца, печать отчётов; +- локализация и интернационализация; +- анализ файлов; +- разные роли для статистики (скрытие финансов); +- разработка бекенда, интеграции с другими системами; + +### Пожелания, предложения, замечания +- telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи) +- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) +- сайт [https://assayo.jp/](https://assayo.jp/) +