diff --git a/documents/EN.md b/documents/EN.md
index 4d29408..0248ffe 100644
--- a/documents/EN.md
+++ b/documents/EN.md
@@ -105,7 +105,7 @@ Creates an HTML-report with analysis of commit statistics:
In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
#### Use github actions
-Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. A ready, fresh report will be saved in the artifacts.
#### Use private server
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
diff --git a/documents/ES.md b/documents/ES.md
index fff4ae3..8193f41 100644
--- a/documents/ES.md
+++ b/documents/ES.md
@@ -105,7 +105,7 @@ Visualización y análisis de los datos de su repositorio git:
En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión.
#### Use github actions
-Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. Se guardará un informe nuevo y listo en los artefactos.
#### Servidor privado
- descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo);
diff --git a/documents/FR.md b/documents/FR.md
index 4f16bdf..fd4ccd1 100644
--- a/documents/FR.md
+++ b/documents/FR.md
@@ -1,19 +1,7 @@
> [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)
-> La [documentation principale](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) est en russe. C'est une traduction. Il peut contenir des erreurs. Si vous êtes un locuteur natif, vous pouvez aider à améliorer cette traduction. Merci!
-
# [Assayo](https://bakhirev.github.io/?ref=github&lang=fr)
-Visualisation et analyse des données de votre dépôt git. Performance tool for Team Lead and IT-audit
-
-**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
-
-**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
-
-
-
-
-
-##### 👨💻 À votre nouveau lieu de travail, vous pouvez instantanément découvrir:
+Crée un rapport HTML avec analyse des statistiques de validation:
- le rythme de travail et le nombre d'heures supplémentaires;
- les zones de responsabilité, le nombre de fonctionnalités et de bogues;
- le style de travail de vos collègues;
@@ -23,48 +11,113 @@ Visualisation et analyse des données de votre dépôt git. Performance tool for
- le coût des fonctionnalités et du projet dans son ensemble;
- les endroits pour le refactoring, les fichiers supprimés, etc.
-
+
+**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/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/852782/).
+
+**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).
+
+
+
+
### Table of contents
-- [Table of contents](#link-1)
-- [De combien de commits avez-vous besoin?](#link-2)
-- [Comment télécharger des données depuis git ?](#link-4)
- - [Pour une visualisation en ligne](#link-5)
- - [Pour la navigation hors ligne](#link-6)
- - [If you use PowerShell in Windows](#link-7)
-- [Comment voir le rapport en ligne?](#link-8)
- - [Using website](#link-9)
- - [Use the library NodeJS](#link-10)
- - [Use the library PHP](#link-11)
- - [Use the library Python](#link-12)
- - [Use the library Ruby](#link-13)
- - [Use the library Go](#link-14)
- - [Use source code](#link-15)
-- [Comment recompiler la build du rapport?](#link-16)
-- [Comment voir le compte rendu pour un groupe de microservices?](#link-17)
-- [Comment apposer une marque sur l’interface?](#link-18)
-- [Comment signer les commits ?](#link-19)
-- [How to add checking for commit message?](#link-20)
- - [ Use file commit-msg](#link-21)
- - [ Use package pre-commit](#link-22)
-- [Comment automatiser la collecte de données?](#link-23)
- - [With backend](#link-24)
- - [Sans back-end](#link-25)
-- [DevOps ](#link-26)
- - [Github Actions](#link-27)
- - [Serveur public](#link-28)
- - [Serveur privé](#link-29)
-- [️ About application](#link-30)
- - [Architecture](#link-31)
- - [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-32)
- - [Comment ajouter ou modifier une traduction?](#link-33)
- - [Souhaits, suggestions, commentaires](#link-34)
+
+
+- [COMMIT STATISTICS REPORT](#link-1)
+ - [Comment voir le rapport en ligne?](#link-2)
+ - [Using website](#link-3)
+ - [Use the library NodeJS](#link-4)
+ - [Use the library PHP](#link-5)
+ - [Use the library Python](#link-6)
+ - [Use the library Ruby](#link-7)
+ - [Use the library Go](#link-8)
+ - [Use source code](#link-9)
+ - [Use github actions](#link-10)
+ - [Serveur privé](#link-11)
+ - [Comment pouvez-vous combiner les auteurs ?](#link-12)
+ - [Comment télécharger des données depuis git ?](#link-13)
+ - [Pour une visualisation en ligne](#link-14)
+ - [Pour la navigation hors ligne](#link-15)
+ - [If you use PowerShell in Windows](#link-16)
+ - [Comment voir le compte rendu pour un groupe de microservices?](#link-17)
+
+
+- [THE BEST PRACTICES IN THE PROJECT](#link-18)
+ - [Comment signer les commits ?](#link-19)
+ - [How to add checking for commit message?](#link-20)
+ - [ Use file commit-msg](#link-21)
+ - [ Use package pre-commit](#link-22)
+
+
+- [ABOUT THIS APP](#link-23)
+ - [Comment apposer une marque sur l’interface?](#link-24)
+ - [Comment recompiler la build du rapport?](#link-25)
+ - [Comment ajouter ou modifier une traduction?](#link-26)
+ - [️Architecture](#link-27)
+ - [The structure of this module](#link-28)
+ - [General architecture of microservices](#link-29)
+ - [Souhaits, suggestions, commentaires](#link-30)
+
+## COMMIT STATISTICS REPORT
-### 🚀 De combien de commits avez-vous besoin?
-Dans le répertoire racine de votre projet, exécutez les commandes suivantes:
-```
-git shortlog -s -n -e
-```
+### 📈 Comment voir le rapport en ligne?
+#### Using website
+- Aller à [сайт](https://bakhirev.github.io/demo/)
+- follow the instructions
+
+
+#### Use the library NodeJS
+- run `npx assayo`
+- open `./assayo/index.html`
+
+
+#### Use the library PHP
+- run `composer require bakhirev/assayo`
+- run `vendor/bin/assayo`
+- open `./assayo/index.html`
+
+
+#### Use the library Python
+- run `pipx install assayo`
+- run `assayo`
+- open `./assayo/index.html`
+
+
+#### Use the library Ruby
+- run `gem install assayo`
+- run `assayo`
+- open `./assayo/index.html`
+
+
+#### Use the library Go
+- run `go get github.com/bakhirev/assayo`
+- run `go install github.com/bakhirev/assayo`
+- run `assayo`
+- open `./assayo/index.html`
+
+
+#### Use source code
+- Télécharger ce dépôt
+- Glisser le fichier `log.txt` dans le dossier `/build`
+- Démarrer `/build/index.html`
+- Ou coller le dossier `/build` Sur votre dépôt (là où se trouve `log.txt`). Vous pouvez changer le nom. Par exemple avec `/build` sur `/report`. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne.
+
+
+#### Use github actions
+Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. A ready, fresh report will be saved in the artifacts.
+
+#### Serveur privé
+- télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo);
+- Soulevez-le sur le réseau local;
+- Pour consulter les rapports, utilisez l’interface web en lui indiquant l’adresse où les données se trouvent, sous forme de paramètre dans l’URL ```dump```:
+
+```
+http://assayo_url/?dump=//you_url/some/log.txt
+assayo_url - URL Conteneur assayo, écoute le port 80;
+you_url - URL адресс Adresse de votre conteneur de logs git;
+```
+Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible.
+
### 🎭 Comment pouvez-vous combiner les auteurs ?
Dans le répertoire racine de votre projet, créez le fichier suivant: `.mailmap`.
L’exemple de la ligne de fichier est le suivant:
@@ -75,79 +128,27 @@ Alex B
Alex B
```
Vous pouvez en savoir plus sur le format de ce fichier en lisant la documentation officielle. [ici](https://git-scm.com/docs/gitmailmap).
-
+
### 📤 Comment télécharger des données depuis git ?
-
+
#### Pour une visualisation en ligne
Dans le répertoire racine de votre projet, exécutez:
```
git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" > log.txt
```
-
+
#### Pour la navigation hors ligne
```
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 va créer le fichier `log.txt`. Son contenu est destiné à la création de rapports. La différence entre le format en ligne et le format hors ligne réside dans l’enveloppe des lignes. Le format hors ligne sera chargé comme un fichier js si vous avez simplement ouvert `/build/index.html`
-
+
#### If you use PowerShell in Windows
By default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command.
```
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
```
Or open a saved file and manually change the encoding to UTF-8.
-
-### 📈 Comment voir le rapport en ligne?
-
-#### Using website
-- Aller à [сайт](https://bakhirev.github.io/)
-- Appuyer sur le bouton “[Démo](https://bakhirev.github.io/demo)”
-- Faites glisser le fichier `log.txt` dans la fenêtre du navigateur
-
-
-#### Use the library NodeJS
-- run `npx assayo`
-- open `./assayo/index.html`
-
-
-#### Use the library PHP
-- run `composer require bakhirev/assayo`
-- run `vendor/bin/assayo`
-- open `./assayo/index.html`
-
-
-#### Use the library Python
-- run `pipx install assayo`
-- run `assayo`
-- open `./assayo/index.html`
-
-
-#### Use the library Ruby
-- run `gem install assayo`
-- run `assayo`
-- open `./assayo/index.html`
-
-
-#### Use the library Go
-- run `go get github.com/bakhirev/assayo`
-- run `go install github.com/bakhirev/assayo`
-- run `assayo`
-- open `./assayo/index.html`
-
-
-#### Use source code
-- Télécharger ce dépôt
-- Glisser le fichier `log.txt` dans le dossier `/build`
-- Démarrer `/build/index.html`
-- Ou coller le dossier `/build` Sur votre dépôt (là où se trouve `log.txt`). Vous pouvez changer le nom. Par exemple avec `/build` sur `/report`. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne.
-
-
-### 🏭 Comment recompiler la build du rapport?
-- Télécharger ce dépôt
-- Exécuter `npm install`
-- Exécuter `npm run build:local`
-- La dernière build sera dans le dossier `/build`
-
### 🗃️ Comment voir le compte rendu pour un groupe de microservices?
- générer un fichier pour chaque microservice `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
@@ -155,14 +156,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- Voir “Comment regarder le rapport hors-ligne?”. Au deuxième pas, coller tous les fichier de microservices (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) dans le dossier du rapport (`/build`).
-### 🎨 Comment apposer une marque sur l’interface?
-Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer :
-- **En-tête**. Vous pouvez le spécifier dans le paramètre de l’URL ```title```. Par exemple: ```?title=You Company```
-- **Thème visuel**.Pour cela, vous devez préparer un fichier CSS avec de nouveaux styles et indiquer son adresse dans le paramètre de l’URL ```theme```. Par exemple: ```?theme=//company.com/some.css```. Vous pouvez utiliser les noms de classes comme sélecteurs. La plupart d’entre elles ne changent pas lors de la sortie de nouvelles versions.
-- **Langue**. Vous pouvez l’indiquer dans le paramètre d’URL ```lang```. Par exemple: ```?lang=es```
-
-
-**Example:** [demo](https://bakhirev.github.io/demo/themes/)
+## THE BEST PRACTICES IN THE PROJECT
### 📝 Comment signer les commits ?
Suivez la pratique [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Par exemple:
@@ -200,65 +194,54 @@ fi
```
2. Run command `npm install pre-commit`
-### 📚 Comment automatiser la collecte de données?
+## ABOUT THIS APP
-#### With backend
-- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
+### 🎨 Comment apposer une marque sur l’interface?
+Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer :
+- **En-tête**. Vous pouvez le spécifier dans le paramètre de l’URL ```title```. Par exemple: ```?title=You Company```
+- **Thème visuel**.Pour cela, vous devez préparer un fichier CSS avec de nouveaux styles et indiquer son adresse dans le paramètre de l’URL ```theme```. Par exemple: ```?theme=//company.com/some.css```. Vous pouvez utiliser les noms de classes comme sélecteurs. La plupart d’entre elles ne changent pas lors de la sortie de nouvelles versions.
+- **Langue**. Vous pouvez l’indiquer dans le paramètre d’URL ```lang```. Par exemple: ```?lang=es```
+
+**Example:** [demo](https://bakhirev.github.io/demo/themes/)
-#### Sans back-end
-- clonez le dépôt que vous voulez ;
-- copiez le dossier `build`;
-- Ouvrez `build/index.html` dans le navigateur et ajoutez-le aux favoris;
-- ajoutez un raccourci sur `build/assets/ci-cd.sh` dans le dossier de démarrage automatique (Windows); Chaque fois que votre ordinateur se recharge, le script mettra à jour les statistiques sur toutes les données qui se sont automatiquement insérées dans la branche principale.
+### 🛠️ Comment recompiler la build du rapport?
+- Télécharger ce dépôt
+- Exécuter `npm install`
+- Exécuter `npm run build:local`
+- La dernière build sera dans le dossier `/build`
-### 🛠️ DevOps (CI/CD)
+### 🈯 Comment ajouter ou modifier une traduction?
+Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```.
+[Instruction](https://github.com/firstcontributions/first-contributions)
-#### Github Actions
-Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
+### 📐 ️Architecture
-#### Serveur public
-Vous pouvez mettre à disposition le fichier avec les données pour construire le rapport sur l’URL publique. Et pour sa visualisation, utiliser l’interface web du site. [assayo](https://bakhirev.github.io/). Tout simplement, indiquez l’adresse où se trouvent les données dans le paramètre de l’URL ```dump```:
+#### The structure of this module
```
-https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
+src
+ |- pages
+ |- Person // all personal dashboards
+ |- Team // all dashboards about team
+ |
+ |- helpers
+ |- Parser // parse text from git log to JS objects
+ |- DataGrip // data grouping and counting values
+ |- achievement // the logic that gives out personal achievements
+ |- Recommendations // the logic that gives out common recommendations
+ |
+ |- translations // translations into other languages
```
-#### Serveur privé
-- télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo);
-- Soulevez-le sur le réseau local;
-- Pour consulter les rapports, utilisez l’interface web en lui indiquant l’adresse où les données se trouvent, sous forme de paramètre dans l’URL ```dump```:
-
-```
-http://assayo_url/?dump=//you_url/some/log.txt
-assayo_url - URL Conteneur assayo, écoute le port 80;
-you_url - URL адресс Adresse de votre conteneur de logs git;
-```
-Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible.
-
-### 🛠️ ️ About application
-
-#### 📐 Architecture
+#### General architecture of microservices
1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) 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.
-
-#### 🈯 Les versions sont publiées environ tous les six mois. Quoi de neuf:
-- plus de conseils et de succès;
-- résultats de l’année / du mois, impression des rapports;
-- localisation et internationalisation;
-- analyse des fichiers;
-- différents rôles pour la statistique (cacher la finance);
-- développement du backend, intégrations avec d’autres systèmes;
-
-
-#### 🗺️ Comment ajouter ou modifier une traduction?
-Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```.
-[Instruction](https://github.com/firstcontributions/first-contributions)
-
-#### 📧 Souhaits, suggestions, commentaires
+
+### 📧 Souhaits, suggestions, commentaires
- telegramm [@bakhirev](https://t.me/bakhirev) (voie de communication prioritaire)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=fr)
diff --git a/documents/src/json/en.json b/documents/src/json/en.json
index 27ceeb7..6332d39 100644
--- a/documents/src/json/en.json
+++ b/documents/src/json/en.json
@@ -106,7 +106,7 @@
"h4": "Use github actions"
},
{
- "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. A ready, fresh report will be saved in the artifacts."
},
{
"h4": "Use private server"
diff --git a/documents/src/json/es.json b/documents/src/json/es.json
index 07c12b4..c58d88f 100644
--- a/documents/src/json/es.json
+++ b/documents/src/json/es.json
@@ -106,7 +106,7 @@
"h4": "Use github actions"
},
{
- "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. Se guardará un informe nuevo y listo en los artefactos."
},
{
"h4": "Servidor privado"
diff --git a/documents/src/json/fr.json b/documents/src/json/fr.json
index 6aa6a6f..ec735b3 100644
--- a/documents/src/json/fr.json
+++ b/documents/src/json/fr.json
@@ -34,9 +34,8 @@
},
{
"li": [
- "Aller à [сайт](https://bakhirev.github.io/)",
- "Appuyer sur le bouton “[Démo](https://bakhirev.github.io/demo)”",
- "Faites glisser le fichier `log.txt` dans la fenêtre du navigateur"
+ "Aller à [website](https://bakhirev.github.io/demo/)",
+ "follow the instructions"
]
},
{
@@ -104,7 +103,7 @@
"h4": "Use github actions"
},
{
- "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace."
+ "p": "Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace. A ready, fresh report will be saved in the artifacts."
},
{
"h4": "Serveur privé"