GIT-0000 feat: add first version

README.md

@@ -0,0 +1,104 @@
+# [Assayo](https://assayo.jp/)
+
+Визуализация и анализ данных вашего git-репозитория.
+
+##### Сотрудник может оценить новое место работы
+- темп работы;
+- количество переработок;
+- зоны ответственности;
+- объем фичей и багов;
+- стиль работы коллег;
+
+##### Руководитель может оценить сотрудников
+- выявить бездельников;
+- прикинуть обьём кода;
+- узнать скорость работы;
+- заметить аномалии поведения;
+- посмотреть динамику работы по неделям;
+
+##### Ивестор может оценить продукт
+- стоимость продукта;
+- стоимость фичей;
+- время на разработку;
+- прогноз времи доработок;
+- прогноз стоимости;
+
+### Как быстро посмотреть количество коммитов?
+
+В корневой директории вашего проекта выполнить:
+```
+git shortlog -s -n -e
+```
+### Как обьединить авторов?
+В корневой директории вашего проекта нужно создать файл `.mailmap`.
+Пример содержания файла:
+```
+Alex B <[email protected]>
+Alex B <[email protected]> <[email protected]>
+Alex B <[email protected]> <[email protected]>
+Alex B <[email protected]> <[email protected]>
+``` 
+Подробнее про формат этого файла можно прочитать тут [https://git-scm.com/docs/gitmailmap](gitmailmap).
+
+### Как выгрузить данные из git?
+
+В корневой директории вашего проекта выполнить:
+```
+git --no-pager log --numstat --oneline --all --no-merges --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' > dump.git
+```
+Git создаст файл `dump.git`.
+Он содержит данные для построения отчёта.
+
+### Как посмотреть отчёт онлайн? 
+
+- Перейти на [сайт](https://assayo.jp/)
+- Нажать кнопку "[Демо](https://assayo.jp/demo)"
+- Перетащить файл `dump.git` в окно браузера
+
+### Как посмотреть отчёт офлайн?
+- Скачать этот репозиторий
+- Перетащить файл `dump.git` в папку `/build`
+- Запустить `/build/index.html`
+- Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `dump.git`). Можно сменить название. Например с `/build` на `/report`
+
+### Как пересобрать билд отчёта?
+- Скачать этот репозиторий
+- Выполнить `npm install`
+- Выполнить `npm run build`
+- Свежая сборка будет в папке `/build`
+
+### Как посмотреть отчёт по группе микросервисов?
+- Сгенерировать для каждого микросервиса `dump.git` (`dump-1.git`, `dump-2.git`, `dump-3.git` и т.д.)
+- См. "Как посмотреть отчёт онлайн?". На последнем шаге перетащить сразу все файлы в окно браузера.
+- См. "Как посмотреть отчёт офлайн?". На втором шаге перетащить все файлы микросервисов (`dump-1.git`, `dump-2.git`, `dump-3.git` и т.д.) в папку отчета (`/build`).
+
+### Как подписывать коммиты?
+
+Следуйте практике [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)`
+
+### RoadMap
+
+Релизы, примерно, раз в полгода. Что дальше:
+
+- больше советов и достижений;
+- итоги года / месяца, печать отчётов;
+- разные роли для статистики (скрытие финансов);
+- разработка бекенда, интеграции с другими системами;
+- локализация и интернационализация;
+
+### Пожелания, предложения, замечания
+- [[email protected]](mailto:[email protected])
+- telegramm [@bakhirev](https://t.me/volarenege)
+- сайт [https://assayo.jp/](https://assayo.jp/)
+

declaration.d.ts

@@ -0,0 +1,9 @@
+declare module '*.scss' {
+  const content: Record<string, string>;
+  export default content;
+}
+
+declare module "*.svg" {
+  const content: React.FunctionComponent<React.SVGAttributes<SVGElement>>;
+  export default content;
+}