diff --git a/README.md b/README.md index 7da7fa0..bdf29ed 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,10 @@ -> 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! +> __[English](https://github.com/bakhirev/assayo)__ | [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) | [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) | [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) | [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) | [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md) | [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) | [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) -> - [English](https://github.com/bakhirev/assayo) -> - [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) -> - [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) -> - [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) -> - [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) -> - [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md) -> - [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) -> - [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) +> 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! # [Assayo](https://assayo.online/?ref=github&lang=en) -📈 Visualization and analysis of your git repository data ([demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt)). +Visualization and analysis of your git repository data ([demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt)). @@ -59,12 +52,14 @@ - [Public server](#link-20) - [Private server](#link-21) - [How to update the Docker image?](#link-22) -- [How to add or edit a translation?](#link-23) -- [RoadMap](#link-24) -- [Contacts](#link-25) +- [About application](#link-23) + - [Architecture](#link-24) + - [How to add or edit a translation?](#link-25) + - [RoadMap](#link-26) + - [Contacts](#link-27) -### 📊 How to quickly view the number of commits? +### 🚀 How to quickly view the number of commits? In the root directory of your project, run: ``` git shortlog -s -n -e @@ -83,7 +78,7 @@ Alex B Read more about the format of this file you can [here](https://git-scm.com/docs/gitmailmap). -### 💾 How to export data from git? +### 📤 How to export data from git? #### For online viewing @@ -101,7 +96,7 @@ This file contains data for show a report. 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? +### 📈 How to view the report? #### Online - go to the [website](https://assayo.online/); @@ -117,7 +112,7 @@ The difference between the online and offline format is the presence of a wrappe In this case, it is important that the `log.txt` file is generated by the command for offline viewing. -### 🛠️ How to rebuild the report build? +### 🏭 How to rebuild the report build? - download this repository - run `npm install` - run `npm run build` @@ -221,7 +216,24 @@ By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work - push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo); -### 📌 Releases are planned approximately once every six months. What’s next: +### ️ 🛠️ About application + + +#### 📐 Architecture + + +1. [Reports showcase UI](###) displays a list of available reports. Each report consists of a title, description, and a list of repositories. +2. [Crawler service](https://github.com/bakhirev/assayo-crawler) collects repository logs for the report. +3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work. + + +#### 🈯 How to add or edit a translation? +You can add a new translation or correct an existing one in the ```ts/translations/``` folder. +[Instruction](https://github.com/firstcontributions/first-contributions) + + +#### 🗺️ RoadMap: +Releases are planned approximately once every six months. What’s next: - more recommendations and achievements; - annual/monthly summaries, report printing; - localization and internationalization; @@ -229,13 +241,8 @@ By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work - different roles for statistics (hiding finances); - development of the backend, integration with other systems; - -### 🈯 How to add or edit a translation? -You can add a new translation or correct an existing one in the ```ts/translations/``` folder. -[Instruction](https://github.com/firstcontributions/first-contributions) - - -### 📧 Feedback, suggestions, comments + +#### 📧 Feedback, suggestions, comments - telegramm [@bakhirev](https://t.me/bakhirev) (priority method of communication) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - website [https://assayo.online/](https://assayo.online/?ref=github&lang=en) diff --git a/documents/RU.md b/documents/RU.md index 9743090..e40cf68 100644 --- a/documents/RU.md +++ b/documents/RU.md @@ -1,16 +1,11 @@ -> - [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) -> - [English](https://github.com/bakhirev/assayo) -> - [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) -> - [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) -> - [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) -> - [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) -> - [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md) -> - [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) +> [English](https://github.com/bakhirev/assayo) | [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) | [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) | [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) | [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) | [Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.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-репозитория ([демо](https://assayo.online/demo/?dump=./test.txt)). + + ##### Сотрудник может оценить новое место работы - темп работы; - количество переработок; @@ -121,7 +116,7 @@ Git создаст файл `log.txt`. - Свежая сборка будет в папке `/build` ### Как посмотреть отчёт по группе микросервисов? -- Сгенерировать для каждого микросервиса файл `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) +- Сгенерировать для каждого микросервиса файл `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`).