dmitriy.kazimirov/assayo
1
0
Fork 0
mirror of https://github.com/bakhirev/assayo.git synced 2024-11-16 08:11:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update

Browse source
This commit is contained in:
bakhirev 2024-08-27 09:15:26 +03:00
parent 0625e577e7
commit ca7b283994
18 changed files with 726 additions and 423 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -34,6 +34,7 @@ Links: [demo](https://assayo.online/demo/?ref=github&dump=./test.txt), [install]
### Table of contents ### Table of contents
- [How to quickly view the number of commits?](#link-1) - [How to quickly view the number of commits?](#link-1)
- [How to create a report?](#link-1-1)
- [How to concat authors?](#link-2) - [How to concat authors?](#link-2)
- [How to export data from git?](#link-3) - [How to export data from git?](#link-3)
- [For online viewing](#link-4) - [For online viewing](#link-4)
@ -68,6 +69,19 @@ In the root directory of your project, run:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-1-1"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-2"></a> <a name="link-2"></a>
### ‍🎭 How to concat authors? ### ‍🎭 How to concat authors?
In the root directory of your project, you need to create a `.mailmap` file. In the root directory of your project, you need to create a `.mailmap` file.

119
documents/DE.md
View file

@ -31,33 +31,34 @@ Visualisierung und analyse ihrer Git-datenbank ([demo](https://assayo.online/dem
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [Wie kann ich die anzahl der commits schnell sehen?](#link-4) - [Wie kann ich die anzahl der commits schnell sehen?](#link-4)
- [Wie kann ich autoren zusammenbringen?](#link-5) - [How to create a report?](#link-5)
- [Wie kann ich daten aus git?](#link-6) - [Wie kann ich autoren zusammenbringen?](#link-6)
- [Für die onlineansicht](#link-7) - [Wie kann ich daten aus git?](#link-7)
- [Zum surfen ohne internet](#link-8) - [Für die onlineansicht](#link-8)
- [If you use PowerShell in Windows](#link-9) - [Zum surfen ohne internet](#link-9)
- [Wie kann ich den bericht sehen?](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [Wie kann ich den bericht sehen?](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [Wie kann ich die berichtsdatei neu erstellen?](#link-13) - [Offline](#link-13)
- [Wie kann ich den bericht zur microservices-gruppe anzeigen?](#link-14) - [Wie kann ich die berichtsdatei neu erstellen?](#link-14)
- [Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?](#link-15) - [Wie kann ich den bericht zur microservices-gruppe anzeigen?](#link-15)
- [Wie signiere ich commits?](#link-16) - [Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?](#link-16)
- [How to add checking for commit message?](#link-17) - [Wie signiere ich commits?](#link-17)
- [ Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [ Use package pre-commit](#link-19) - [ Use file commit-msg](#link-19)
- [Wie kann ich die datenerfassung automatisieren?](#link-20) - [ Use package pre-commit](#link-20)
- [With backend](#link-21) - [Wie kann ich die datenerfassung automatisieren?](#link-21)
- [Kein bekend](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [Kein bekend](#link-23)
- [Öffentlicher server](#link-24) - [DevOps ](#link-24)
- [Privater server](#link-25) - [Öffentlicher server](#link-25)
- [Aktualisieren eines Docker-Images](#link-26) - [Privater server](#link-26)
- [️ About application](#link-27) - [Aktualisieren eines Docker-Images](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-29) - [Architecture](#link-29)
- [Wie kann ich eine übersetzung hinzufügen oder bearbeiten?](#link-30) - [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-30)
- [Wünsche, Anregungen, Kommentare](#link-31) - [Wie kann ich eine übersetzung hinzufügen oder bearbeiten?](#link-31)
- [Wünsche, Anregungen, Kommentare](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 Wie kann ich die anzahl der commits schnell sehen? ### 🚀 Wie kann ich die anzahl der commits schnell sehen?
In der wurzelverzeichnis ihres projektes muss der befehl ausgeführt werden: In der wurzelverzeichnis ihres projektes muss der befehl ausgeführt werden:
@ -65,6 +66,18 @@ In der wurzelverzeichnis ihres projektes muss der befehl ausgeführt werden:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 Wie kann ich autoren zusammenbringen? ### ‍🎭 Wie kann ich autoren zusammenbringen?
Sie müssen eine datei im stammverzeichnis ihres projekts erstellen `.mailmap`. Sie müssen eine datei im stammverzeichnis ihres projekts erstellen `.mailmap`.
Beispiel für den Inhalt einer Datei: Beispiel für den Inhalt einer Datei:
@ -75,59 +88,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Sie können mehr über das format dieser datei lesen[hier](https://git-scm.com/docs/gitmailmap). Sie können mehr über das format dieser datei lesen[hier](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Wie kann ich daten aus git?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Wie kann ich daten aus git?
<a name="link-8"></a>
#### Für die onlineansicht #### Für die onlineansicht
In der wurzelverzeichnis ihres projektes ausführen: In der wurzelverzeichnis ihres projektes ausführen:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### Zum surfen ohne internet #### Zum surfen ohne internet
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git erstellt eine datei `log.txt`. Diese datei enthält die daten zum erstellen des berichts. Der unterschied zwischen den formaten liegt im vorhandensein einer wrapper für zeilen. Das format ohne internet wird wie eine js-datei geladen, wenn sie es einfach öffnen. `/build/index.html` Git erstellt eine datei `log.txt`. Diese datei enthält die daten zum erstellen des berichts. Der unterschied zwischen den formaten liegt im vorhandensein einer wrapper für zeilen. Das format ohne internet wird wie eine js-datei geladen, wenn sie es einfach öffnen. `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 Wie kann ich den bericht sehen?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 Wie kann ich den bericht sehen?
<a name="link-12"></a>
#### Online #### Online
- gehe zu [Webseite](https://assayo.online/) - gehe zu [Webseite](https://assayo.online/)
- den knopf drücken “[Demonstration](https://assayo.online/demo?lang=ru)” - den knopf drücken “[Demonstration](https://assayo.online/demo?lang=ru)”
- datei ziehen `log.txt` in das Browserfenster - datei ziehen `log.txt` in das Browserfenster
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- laden sie dieses repository herunter - laden sie dieses repository herunter
- datei ziehen `log.txt` in den ordner`/build` - datei ziehen `log.txt` in den ordner`/build`
- starten `/build/index.html` - starten `/build/index.html`
- oder ziehen sie einen ordner `/build` zu sich ins repository (der ort, an dem es liegt `log.txt`). Sie können den namen ändern. zum beispiel mit dem namen `/build` auf den namen `/report` - oder ziehen sie einen ordner `/build` zu sich ins repository (der ort, an dem es liegt `log.txt`). Sie können den namen ändern. zum beispiel mit dem namen `/build` auf den namen `/report`
Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstellt wird. Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstellt wird.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 Wie kann ich die berichtsdatei neu erstellen? ### 🏭 Wie kann ich die berichtsdatei neu erstellen?
- Laden sie dieses repository herunter - Laden sie dieses repository herunter
- Erfüllen `npm install` - Erfüllen `npm install`
- Erfüllen `npm run build:local` - Erfüllen `npm run build:local`
- Der neue build wird im ordner sein `/build` - Der neue build wird im ordner sein `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ Wie kann ich den bericht zur microservices-gruppe anzeigen? ### 🗃️ Wie kann ich den bericht zur microservices-gruppe anzeigen?
- Datei für jeden microservice generieren `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.) - Datei für jeden microservice generieren `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.)
- Siehe “Wie kann ich den bericht mit internet ansehen?”. Im letzten schritt ziehen sie alle dateien gleichzeitig in das browserfenster. - Siehe “Wie kann ich den bericht mit internet ansehen?”. Im letzten schritt ziehen sie alle dateien gleichzeitig in das browserfenster.
- Siehe “Wie kann man den bericht ohne internet ansehen?” Im zweiten schritt ziehen sie die microservice-dateien alle (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.) in den berichtsordner (`/build`). - Siehe “Wie kann man den bericht ohne internet ansehen?” Im zweiten schritt ziehen sie die microservice-dateien alle (`log-1.txt`, `log-2.txt`, `log-3.txt` usw.) in den berichtsordner (`/build`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen? ### 🎨 Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?
Sie können ihr skin für die schnittstelle schreiben. Kann geändert werden: Sie können ihr skin für die schnittstelle schreiben. Kann geändert werden:
- **Überschrift**. Sie können es im URL-parameter angeben ```title```. Zum beispiel: ```?title=you company``` - **Überschrift**. Sie können es im URL-parameter angeben ```title```. Zum beispiel: ```?title=you company```
- **CSS stile**. Um dies zu tun, müssen sie die CSS-datei vorbereiten und ihre adresse im URL-parameter angeben ```theme```. Zum beispiel: ```?theme=//company.com/some.css```. Sie können klassennamen als selektoren verwenden. Die meisten von ihnen ändern sich nicht, wenn eine neue version veröffentlicht wird. - **CSS stile**. Um dies zu tun, müssen sie die CSS-datei vorbereiten und ihre adresse im URL-parameter angeben ```theme```. Zum beispiel: ```?theme=//company.com/some.css```. Sie können klassennamen als selektoren verwenden. Die meisten von ihnen ändern sich nicht, wenn eine neue version veröffentlicht wird.
- **Sprache**. Sie können es im URL-parameter angeben ```lang```. Zum Beispiel: ```?lang=es``` - **Sprache**. Sie können es im URL-parameter angeben ```lang```. Zum Beispiel: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 Wie signiere ich commits? ### 📝 Wie signiere ich commits?
Folge der praxis [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Zum beispiel: Folge der praxis [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Zum beispiel:
``` ```
@ -137,9 +150,9 @@ JIRA-1234 feat(profile): added avatar for user
- art der arbeit `(feat, fix, style, refactor, test, doc usw.)` - art der arbeit `(feat, fix, style, refactor, test, doc usw.)`
- arbeitsbereich `(profile - ein abschnitt der website, eine seite oder eine neue funktionalität, mit einem wort)` - arbeitsbereich `(profile - ein abschnitt der website, eine seite oder eine neue funktionalität, mit einem wort)`
- beschreibung der arbeit `(added avatar for user)` - beschreibung der arbeit `(added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -150,7 +163,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -162,27 +175,27 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 Wie kann ich die datenerfassung automatisieren?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 Wie kann ich die datenerfassung automatisieren?
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Kein bekend #### Kein bekend
- erstellen sie einen klon ihres repositorys; - erstellen sie einen klon ihres repositorys;
- kopieren sie den ordner `build` aus dem aktuellen repository; - kopieren sie den ordner `build` aus dem aktuellen repository;
- öffnen `build/index.html` im browser und zu lesezeichen hinzufügen; - öffnen `build/index.html` im browser und zu lesezeichen hinzufügen;
- fügen sie eine verknüpfung hinzu `build/assets/ci-cd.sh` in den startordner (windows); - fügen sie eine verknüpfung hinzu `build/assets/ci-cd.sh` in den startordner (windows);
Jedes mal, wenn der computer neu gestartet wird, aktualisiert das skript die statistiken für alle daten, die automatisch in den hauptzweig aufgenommen wurden. Jedes mal, wenn der computer neu gestartet wird, aktualisiert das skript die statistiken für alle daten, die automatisch in den hauptzweig aufgenommen wurden.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Öffentlicher server #### Öffentlicher server
Sie können eine datendatei zum erstellen eines berichts auf eine öffentliche URL hochladen. Sie können die Website verwenden, um sie zu visualisieren [assayo](https://assayo.online/). Geben sie im URL-parameter die adresse an, an der die daten liegen ```dump```: Sie können eine datendatei zum erstellen eines berichts auf eine öffentliche URL hochladen. Sie können die Website verwenden, um sie zu visualisieren [assayo](https://assayo.online/). Geben sie im URL-parameter die adresse an, an der die daten liegen ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Privater server #### Privater server
- herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo); - herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo);
- führen Sie es im lokalen netzwerk aus; - führen Sie es im lokalen netzwerk aus;
@ -193,30 +206,30 @@ assayo_url - die adresse des assayo-containers, er hört auf port 80;
you_url - URL die adresse ihres containers mit git-logs; you_url - URL die adresse ihres containers mit git-logs;
``` ```
Standardmäßig wird das abbild an der folgenden adresse ausgeführt ```http://127.0.0.1:80/```. Wenn es nicht funktioniert, überprüfen sie, ob der port 80 frei ist. Standardmäßig wird das abbild an der folgenden adresse ausgeführt ```http://127.0.0.1:80/```. Wenn es nicht funktioniert, überprüfen sie, ob der port 80 frei ist.
<a name="link-26"></a> <a name="link-27"></a>
#### Aktualisieren eines Docker-Images #### Aktualisieren eines Docker-Images
- befehl ausführen ```npm run build:docker``` - befehl ausführen ```npm run build:docker```
- befehl ausführen ```docker build -t assayo .``` - befehl ausführen ```docker build -t assayo .```
- ergebnis überprüfen ```docker run --name assayo -p 80:80 -d assayo```; - ergebnis überprüfen ```docker run --name assayo -p 80:80 -d assayo```;
- befehl ausführen ```docker tag assayo bakhirev/assayo:latest```; - befehl ausführen ```docker tag assayo bakhirev/assayo:latest```;
- senden sie ein containerimage an Docker Hub ```docker push bakhirev/assayo:latest```; - senden sie ein containerimage an Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 Veröffentlichungen, ungefähr alle sechs monate. Was weiter: #### 🈯 Veröffentlichungen, ungefähr alle sechs monate. Was weiter:
Schau [haupt dokumentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) Schau [haupt dokumentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ Wie kann ich eine übersetzung hinzufügen oder bearbeiten? #### 🗺️ Wie kann ich eine übersetzung hinzufügen oder bearbeiten?
Sie können eine neue übersetzung hinzufügen oder die aktuelle im abschnitt korrigieren ```ts/translations/```. Sie können eine neue übersetzung hinzufügen oder die aktuelle im abschnitt korrigieren ```ts/translations/```.
[Anleitung](https://github.com/firstcontributions/first-contributions) [Anleitung](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Wünsche, Anregungen, Kommentare #### 📧 Wünsche, Anregungen, Kommentare
- telegramm [@bakhirev](https://t.me/bakhirev) (vorrangiger kommunikationsweg) - telegramm [@bakhirev](https://t.me/bakhirev) (vorrangiger kommunikationsweg)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/EN.md
View file

@ -32,33 +32,34 @@ Visualization and analysis of git commit statistics. Team Lead performance tool.
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [How to quickly view the number of commits?](#link-4) - [How to quickly view the number of commits?](#link-4)
- [How to concat authors?](#link-5) - [How to create a report?](#link-5)
- [How to export data from git?](#link-6) - [How to concat authors?](#link-6)
- [For online viewing](#link-7) - [How to export data from git?](#link-7)
- [For offline viewing](#link-8) - [For online viewing](#link-8)
- [If you use PowerShell in Windows](#link-9) - [For offline viewing](#link-9)
- [How to view the report?](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [How to view the report?](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [How to rebuild the HTML report from source code?](#link-13) - [Offline](#link-13)
- [How to view a report on a group of microservices?](#link-14) - [How to rebuild the HTML report from source code?](#link-14)
- [How to brand the interface?](#link-15) - [How to view a report on a group of microservices?](#link-15)
- [How to sign commits?](#link-16) - [How to brand the interface?](#link-16)
- [How to add checking for commit message?](#link-17) - [How to sign commits?](#link-17)
- [Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [Use package pre-commit](#link-19) - [Use file commit-msg](#link-19)
- [How to automate data collection?](#link-20) - [Use package pre-commit](#link-20)
- [With backend](#link-21) - [How to automate data collection?](#link-21)
- [Without backend](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [Without backend](#link-23)
- [Public server](#link-24) - [DevOps ](#link-24)
- [Private server](#link-25) - [Public server](#link-25)
- [How to update the Docker image?](#link-26) - [Private server](#link-26)
- [️ About application](#link-27) - [How to update the Docker image?](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [How to add or edit a translation?](#link-29) - [Architecture](#link-29)
- [RoadMap:](#link-30) - [How to add or edit a translation?](#link-30)
- [Feedback, comments](#link-31) - [RoadMap:](#link-31)
- [Feedback, comments](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 How to quickly view the number of commits? ### 🚀 How to quickly view the number of commits?
In the root directory of your project, run: In the root directory of your project, run:
@ -66,6 +67,18 @@ In the root directory of your project, run:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 How to concat authors? ### ‍🎭 How to concat authors?
In the root directory of your project, you need to create a `.mailmap` file. In the root directory of your project, you need to create a `.mailmap` file.
Example of the contents of the file: Example of the contents of the file:
@ -76,59 +89,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Read more about the format of this file you can [here](https://git-scm.com/docs/gitmailmap). Read more about the format of this file you can [here](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 How to export data from git?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 How to export data from git?
<a name="link-8"></a>
#### For online viewing #### For online viewing
In the root directory of your project run: In the root directory of your project run:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### For offline viewing #### For offline viewing
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git will create a file `log.txt`. 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 ` Git will create a file `log.txt`. 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 `
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 How to view the report?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 How to view the report?
<a name="link-12"></a>
#### Online #### Online
- go to the [website](https://assayo.online/); - go to the [website](https://assayo.online/);
- click the “[Demo](https://assayo.online/demo?ref=github&lang=en)” button; - click the “[Demo](https://assayo.online/demo?ref=github&lang=en)” button;
- drop the `log.txt` file into the browser window; - drop the `log.txt` file into the browser window;
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- download this repository `git clone https://github.com/bakhirev/assayo.git`; - download this repository `git clone https://github.com/bakhirev/assayo.git`;
- drop the `log.txt` file to the `/build` folder; - drop the `log.txt` file to the `/build` folder;
- run `/build/index.html`; - run `/build/index.html`;
- or drop the `/build` folder to your repository (where the `log.txt` is located). You can change the name. For example, from `/build` to `/report`. - or drop the `/build` folder to your repository (where the `log.txt` is located). You can change the name. For example, from `/build` to `/report`.
In this case, it is important that the `log.txt` file is generated by the command for offline viewing. In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 How to rebuild the HTML report from source code? ### 🏭 How to rebuild the HTML report from source code?
- download this repository `git clone https://github.com/bakhirev/assayo.git` - download this repository `git clone https://github.com/bakhirev/assayo.git`
- run `npm install` - run `npm install`
- run `npm run build:local` - run `npm run build:local`
- the new HTML build will be in the `/build` folder - the new HTML build will be in the `/build` folder
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ How to view a report on a group of microservices? ### 🗃️ How to view a report on a group of microservices?
- generate for each microservice file `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) You can do this manually, or use the [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) module for automatic log collection; - generate for each microservice file `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) You can do this manually, or use the [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) module for automatic log collection;
- see “How to view an online report?”. At the last step, drag all the files at once into the browser window. - 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`). - 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`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 How to brand the interface? ### 🎨 How to brand the interface?
You can create your own interface theme. Options: You can create your own interface theme. Options:
- **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company``` - **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company```
- **Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions. - **Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions.
- **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es``` - **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 How to sign commits? ### 📝 How to sign commits?
Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example: Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:
``` ```
@ -138,9 +151,9 @@ JIRA-1234 feat(profile): Added avatar for user
- type of work `(feat, fix, style, refactor, test, doc и т.д.)` - type of work `(feat, fix, style, refactor, test, doc и т.д.)`
- feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)` - feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`
- what problem were solved `(Added avatar for user)` - what problem were solved `(Added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -151,7 +164,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -163,27 +176,27 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 How to automate data collection?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 How to automate data collection?
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Without backend #### Without backend
- create a clone of the repository you need; - create a clone of the repository you need;
- copy the `build` folder to the root; - copy the `build` folder to the root;
- open `build/index.html` in the browser and add it to bookmarks; - open `build/index.html` in the browser and add it to bookmarks;
- add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows); - add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows);
Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch. Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Public server #### Public server
You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://assayo.online/?ref=github&lang=en) to visualize it. You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://assayo.online/?ref=github&lang=en) to visualize it.
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Private server #### Private server
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo); - download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
- run it on your local network; - run it on your local network;
@ -194,27 +207,27 @@ assayo_url - URL of the assayo container, it listens on port 80;
you_url - URL of your container with git logs; you_url - URL of your container with git logs;
``` ```
By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free. By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free.
<a name="link-26"></a> <a name="link-27"></a>
#### How to update the Docker image? #### How to update the Docker image?
- run ```npm run build:docker``` - run ```npm run build:docker```
- run ```docker build -t assayo .``` - run ```docker build -t assayo .```
- visually check the image ```docker run --name assayo -p 80:80 -d assayo```; - visually check the image ```docker run --name assayo -p 80:80 -d assayo```;
- add tag ```docker tag assayo bakhirev/assayo:latest```; - add tag ```docker tag assayo bakhirev/assayo:latest```;
- push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```; - push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 How to add or edit a translation? #### 🈯 How to add or edit a translation?
You can add a new translation or correct an existing one in the ```ts/translations/``` folder. You can add a new translation or correct an existing one in the ```ts/translations/``` folder.
[Instruction](https://github.com/firstcontributions/first-contributions) [Instruction](https://github.com/firstcontributions/first-contributions)
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ RoadMap: #### 🗺️ RoadMap:
Releases are planned approximately once every six months. What’s next: Releases are planned approximately once every six months. What’s next:
- more recommendations and achievements; - more recommendations and achievements;
@ -223,7 +236,7 @@ Releases are planned approximately once every six months. What’s next:
- file analysis; - file analysis;
- different roles for statistics (hiding finances); - different roles for statistics (hiding finances);
- development of the backend, integration with other systems; - development of the backend, integration with other systems;
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Feedback, comments #### 📧 Feedback, comments
- telegramm [@bakhirev](https://t.me/bakhirev) (priority method of communication) - telegramm [@bakhirev](https://t.me/bakhirev) (priority method of communication)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/ES.md
View file

@ -32,33 +32,34 @@ Visualización y análisis de los datos de su repositorio git. ([demo](https://a
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [Cómo puedo rápidamente ver el número de commits?](#link-4) - [Cómo puedo rápidamente ver el número de commits?](#link-4)
- [Cómo combinar a los autores?](#link-5) - [How to create a report?](#link-5)
- [Cómo descargar los datos desde git?](#link-6) - [Cómo combinar a los autores?](#link-6)
- [Para la visualización en línea](#link-7) - [Cómo descargar los datos desde git?](#link-7)
- [Para ver sin conexión](#link-8) - [Para la visualización en línea](#link-8)
- [If you use PowerShell in Windows](#link-9) - [Para ver sin conexión](#link-9)
- [¿Cómo ver el informe?](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [¿Cómo ver el informe?](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [Como recompilar el build de un informe?](#link-13) - [Offline](#link-13)
- [Como mirar el reporte de un grupo de microservicios?](#link-14) - [Como recompilar el build de un informe?](#link-14)
- [¿Cómo puedo personalizar la interfaz de usuario?](#link-15) - [Como mirar el reporte de un grupo de microservicios?](#link-15)
- [¿Cómo firmar los commits?](#link-16) - [¿Cómo puedo personalizar la interfaz de usuario?](#link-16)
- [How to add checking for commit message?](#link-17) - [¿Cómo firmar los commits?](#link-17)
- [ Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [ Use package pre-commit](#link-19) - [ Use file commit-msg](#link-19)
- [¿Cómo automatizar el recolección de datos?](#link-20) - [ Use package pre-commit](#link-20)
- [With backend](#link-21) - [¿Cómo automatizar el recolección de datos?](#link-21)
- [Sin backend](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [Sin backend](#link-23)
- [Servidor público](#link-24) - [DevOps ](#link-24)
- [Servidor privado](#link-25) - [Servidor público](#link-25)
- [Actualización de la imagen Docker](#link-26) - [Servidor privado](#link-26)
- [️ About application](#link-27) - [Actualización de la imagen Docker](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-29) - [Architecture](#link-29)
- [¿Cómo añadir o editar una traducción?](#link-30) - [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-30)
- [Deseos, comentarios](#link-31) - [¿Cómo añadir o editar una traducción?](#link-31)
- [Deseos, comentarios](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 Cómo puedo rápidamente ver el número de commits? ### 🚀 Cómo puedo rápidamente ver el número de commits?
En la carpeta raíz de su proyecto, ejecute: En la carpeta raíz de su proyecto, ejecute:
@ -66,6 +67,18 @@ En la carpeta raíz de su proyecto, ejecute:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 Cómo combinar a los autores? ### ‍🎭 Cómo combinar a los autores?
En la carpeta raíz de su proyecto debe crear un archivo `.mailmap`. En la carpeta raíz de su proyecto debe crear un archivo `.mailmap`.
Un ejemplo del contenido del archivo: Un ejemplo del contenido del archivo:
@ -76,59 +89,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Más información sobre el formato de este archivo se puede leer en [aquí](https://git-scm.com/docs/gitmailmap). Más información sobre el formato de este archivo se puede leer en [aquí](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Cómo descargar los datos desde git?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Cómo descargar los datos desde git?
<a name="link-8"></a>
#### Para la visualización en línea #### Para la visualización en línea
En el directorio raíz de su proyecto ejecutar: En el directorio raíz de su proyecto ejecutar:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### Para ver sin conexión #### Para ver sin conexión
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git creará un archivo `log.txt`. contiene los datos para construir el informe. La diferencia entre los formatos en línea y fuera de línea está en la existencia de una envoltura para las cadenas. El formato fuera de línea se cargará como un archivo`js` si usted simplemente lo abrió. `/build/index.html` Git creará un archivo `log.txt`. contiene los datos para construir el informe. La diferencia entre los formatos en línea y fuera de línea está en la existencia de una envoltura para las cadenas. El formato fuera de línea se cargará como un archivo`js` si usted simplemente lo abrió. `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 ¿Cómo ver el informe?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 ¿Cómo ver el informe?
<a name="link-12"></a>
#### Online #### Online
- Ir a [sitio web](https://assayo.online/) - Ir a [sitio web](https://assayo.online/)
- Pulse el botón [Demo](https://assayo.online/demo?ref=github&lang=es)» - Pulse el botón [Demo](https://assayo.online/demo?ref=github&lang=es)»
- Arrastrar y soltar archivo `log.txt` en la ventana del navegador - Arrastrar y soltar archivo `log.txt` en la ventana del navegador
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- Descargar este repositorio - Descargar este repositorio
- Arrastrar y soltar archivo `log.txt` en la carpeta `/build` - Arrastrar y soltar archivo `log.txt` en la carpeta `/build`
- Lanzar `/build/index.html` - Lanzar `/build/index.html`
- O arrastrar una carpeta `/build` a su repositorio (donde se encuentra ' log.txt`). Puede cambiar el nombre. Por ejemplo `/build` contra `/report` - O arrastrar una carpeta `/build` a su repositorio (donde se encuentra ' log.txt`). Puede cambiar el nombre. Por ejemplo `/build` contra `/report`
En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión. En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 Como recompilar el build de un informe? ### 🏭 Como recompilar el build de un informe?
- Descargar este repositorio - Descargar este repositorio
- Ejecutar `npm install` - Ejecutar `npm install`
- Ejecutar `npm run build:local` - Ejecutar `npm run build:local`
- La nueva compilación estará en el directorio `/build` - La nueva compilación estará en el directorio `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ Como mirar el reporte de un grupo de microservicios? ### 🗃️ Como mirar el reporte de un grupo de microservicios?
- Generar para cada microservicio el archivo `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) - Generar para cada microservicio el archivo `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Ver “Cómo ver el informe en línea?”. En el último paso, arrastrar todos los archivos al navegador. - Ver “Cómo ver el informe en línea?”. En el último paso, arrastrar todos los archivos al navegador.
- Ver “Cómo ver informe fuera de línea?”. En el segundo paso, arrastrar los archivos de todos los microservicios al navegador (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) la carpeta informe (`/build`). - Ver “Cómo ver informe fuera de línea?”. En el segundo paso, arrastrar los archivos de todos los microservicios al navegador (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) la carpeta informe (`/build`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 ¿Cómo puedo personalizar la interfaz de usuario? ### 🎨 ¿Cómo puedo personalizar la interfaz de usuario?
Puedes crear tu propio tema para la interfaz. Puedes cambiar: Puedes crear tu propio tema para la interfaz. Puedes cambiar:
- **El título**. Puedes especificarlo en el parámetro de la URL ```title```. Por ejemplo: ```?title=You Company``` - **El título**. Puedes especificarlo en el parámetro de la URL ```title```. Por ejemplo: ```?title=You Company```
- **El tema visual**. Para esto, debes preparar un archivo CSS con los nuevos estilos y especificar su dirección en el parámetro de URL ```theme```. Por ejemplo: ```?theme=//company.com/some.css```. Puedes usar los nombres de clases como selectores. La mayoría de ellos no cambia con el lanzamiento de nuevas versiones. - **El tema visual**. Para esto, debes preparar un archivo CSS con los nuevos estilos y especificar su dirección en el parámetro de URL ```theme```. Por ejemplo: ```?theme=//company.com/some.css```. Puedes usar los nombres de clases como selectores. La mayoría de ellos no cambia con el lanzamiento de nuevas versiones.
- **La lengua**. Puedes especificarla en el parámetro de la URL ```lang```. Por ejemplo: ```?lang=es``` - **La lengua**. Puedes especificarla en el parámetro de la URL ```lang```. Por ejemplo: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 ¿Cómo firmar los commits? ### 📝 ¿Cómo firmar los commits?
Siga la práctica [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por ejemplo: Siga la práctica [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por ejemplo:
``` ```
@ -138,9 +151,9 @@ JIRA-1234 feat(profile): Added avatar for user
- tipo de trabajo `(feat, fix, style, refactor, test, doc etc.)` - tipo de trabajo `(feat, fix, style, refactor, test, doc etc.)`
- ficha `(profile - La sección del sitio, la página o la nueva funcionalidad, en una palabra)` - ficha `(profile - La sección del sitio, la página o la nueva funcionalidad, en una palabra)`
- ¿qué problema resolvieron? `(Added avatar for user)` - ¿qué problema resolvieron? `(Added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -151,7 +164,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -163,12 +176,12 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 ¿Cómo automatizar el recolección de datos?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 ¿Cómo automatizar el recolección de datos?
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Sin backend #### Sin backend
- clone del repositorio que desea; - clone del repositorio que desea;
- copiar a la carpeta raíz `build`; - copiar a la carpeta raíz `build`;
@ -176,15 +189,15 @@ fi
- agregue un icono de `build/assets/ci-cd.sh` a su carpeta de inicio automático - agregue un icono de `build/assets/ci-cd.sh` a su carpeta de inicio automático
(Windows); (Windows);
Cada vez que reinicie su computadora, el script actualizará la estadística de todos los datos que se hayan incorporado automáticamente a la rama principal. Cada vez que reinicie su computadora, el script actualizará la estadística de todos los datos que se hayan incorporado automáticamente a la rama principal.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Servidor público #### Servidor público
Puede publicar el archivo con los datos para generar el informe en una URL pública. Para visualizarlo, puede usar la interfaz web del sitio [assayo](https://assayo.online/). Simplemente indique la dirección donde están los datos en el parámetro URL ```dump```: Puede publicar el archivo con los datos para generar el informe en una URL pública. Para visualizarlo, puede usar la interfaz web del sitio [assayo](https://assayo.online/). Simplemente indique la dirección donde están los datos en el parámetro URL ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Servidor privado #### Servidor privado
- descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo); - descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- recogerlo en la red local; - recogerlo en la red local;
@ -195,23 +208,23 @@ assayo_url - URL dirección del contenedor assayo, Él está escuchando el puert
you_url - URL la dirección de su contenedor con registros git; you_url - URL la dirección de su contenedor con registros git;
``` ```
Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.0.1:80/```. Si no funciona, compruebe si tiene el puerto 80 disponible Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.0.1:80/```. Si no funciona, compruebe si tiene el puerto 80 disponible
<a name="link-26"></a> <a name="link-27"></a>
#### Actualización de la imagen Docker #### Actualización de la imagen Docker
- construir ```npm run build:docker``` - construir ```npm run build:docker```
- montar la imagen ```docker build -t assayo .``` - montar la imagen ```docker build -t assayo .```
- comprobar visualmente la imagen ```docker run --name assayo -p 80:80 -d assayo```; - comprobar visualmente la imagen ```docker run --name assayo -p 80:80 -d assayo```;
- poner la etiqueta ```docker tag assayo bakhirev/assayo:latest```; - poner la etiqueta ```docker tag assayo bakhirev/assayo:latest```;
- poner la imagen en Docker Hub ```docker push bakhirev/assayo:latest```; - poner la imagen en Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será: #### 🈯 Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:
- más consejos y logros; - más consejos y logros;
- resultados del año / mes, impresión de informes; - resultados del año / mes, impresión de informes;
@ -219,11 +232,11 @@ Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.
- análisis de archivos; - análisis de archivos;
- diferentes roles para estadísticas (ocultación de finanzas); - diferentes roles para estadísticas (ocultación de finanzas);
- desarrollo de la parte de atrás, integraciones con otros sistemas; - desarrollo de la parte de atrás, integraciones con otros sistemas;
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ ¿Cómo añadir o editar una traducción? #### 🗺️ ¿Cómo añadir o editar una traducción?
Puede agregar una nueva traducción o corregir la actual en la sección ```ts/translations/```. Puede agregar una nueva traducción o corregir la actual en la sección ```ts/translations/```.
[Instrucciones](https://github.com/firstcontributions/first-contributions) [Instrucciones](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Deseos, comentarios #### 📧 Deseos, comentarios
- telegramm [@bakhirev](https://t.me/bakhirev) (La forma preferencial de contacto) - telegramm [@bakhirev](https://t.me/bakhirev) (La forma preferencial de contacto)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/FR.md
View file

@ -32,33 +32,34 @@ Visualisation et analyse des données de votre dépôt Git ([demo](https://assay
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [De combien de commits avez-vous besoin?](#link-4) - [De combien de commits avez-vous besoin?](#link-4)
- [Comment pouvez-vous combiner les auteurs ?](#link-5) - [How to create a report?](#link-5)
- [Comment télécharger des données depuis git ?](#link-6) - [Comment pouvez-vous combiner les auteurs ?](#link-6)
- [Pour une visualisation en ligne](#link-7) - [Comment télécharger des données depuis git ?](#link-7)
- [Pour la navigation hors ligne](#link-8) - [Pour une visualisation en ligne](#link-8)
- [If you use PowerShell in Windows](#link-9) - [Pour la navigation hors ligne](#link-9)
- [Comment voir le rapport en ligne?](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [Comment voir le rapport en ligne?](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [Comment recompiler la build du rapport?](#link-13) - [Offline](#link-13)
- [Comment voir le compte rendu pour un groupe de microservices?](#link-14) - [Comment recompiler la build du rapport?](#link-14)
- [Comment apposer une marque sur l’interface?](#link-15) - [Comment voir le compte rendu pour un groupe de microservices?](#link-15)
- [Comment signer les commits ?](#link-16) - [Comment apposer une marque sur l’interface?](#link-16)
- [How to add checking for commit message?](#link-17) - [Comment signer les commits ?](#link-17)
- [ Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [ Use package pre-commit](#link-19) - [ Use file commit-msg](#link-19)
- [Comment automatiser la collecte de données?](#link-20) - [ Use package pre-commit](#link-20)
- [With backend](#link-21) - [Comment automatiser la collecte de données?](#link-21)
- [Sans back-end](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [Sans back-end](#link-23)
- [Serveur public](#link-24) - [DevOps ](#link-24)
- [Serveur privé](#link-25) - [Serveur public](#link-25)
- [Mise à jour de l’image-Docker](#link-26) - [Serveur privé](#link-26)
- [️ About application](#link-27) - [Mise à jour de l’image-Docker](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-29) - [Architecture](#link-29)
- [Comment ajouter ou modifier une traduction?](#link-30) - [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-30)
- [Souhaits, suggestions, commentaires](#link-31) - [Comment ajouter ou modifier une traduction?](#link-31)
- [Souhaits, suggestions, commentaires](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 De combien de commits avez-vous besoin? ### 🚀 De combien de commits avez-vous besoin?
Dans le répertoire racine de votre projet, exécutez les commandes suivantes: Dans le répertoire racine de votre projet, exécutez les commandes suivantes:
@ -66,6 +67,18 @@ Dans le répertoire racine de votre projet, exécutez les commandes suivantes:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 Comment pouvez-vous combiner les auteurs ? ### ‍🎭 Comment pouvez-vous combiner les auteurs ?
Dans le répertoire racine de votre projet, créez le fichier suivant: `.mailmap`. Dans le répertoire racine de votre projet, créez le fichier suivant: `.mailmap`.
L’exemple de la ligne de fichier est le suivant: L’exemple de la ligne de fichier est le suivant:
@ -76,58 +89,58 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Vous pouvez en savoir plus sur le format de ce fichier en lisant la documentation officielle. [ici](https://git-scm.com/docs/gitmailmap). Vous pouvez en savoir plus sur le format de ce fichier en lisant la documentation officielle. [ici](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Comment télécharger des données depuis git ?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Comment télécharger des données depuis git ?
<a name="link-8"></a>
#### Pour une visualisation en ligne #### Pour une visualisation en ligne
Dans le répertoire racine de votre projet, exécutez: 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 git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### Pour la navigation hors ligne #### 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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` 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`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 Comment voir le rapport en ligne?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 Comment voir le rapport en ligne?
<a name="link-12"></a>
#### Online #### Online
- Aller à [сайт](https://assayo.online/) - Aller à [сайт](https://assayo.online/)
- Appuyer sur le bouton “[Démo](https://assayo.online/demo?ref=github&lang=fr)” - Appuyer sur le bouton “[Démo](https://assayo.online/demo?ref=github&lang=fr)”
- Faites glisser le fichier `log.txt` dans la fenêtre du navigateur - Faites glisser le fichier `log.txt` dans la fenêtre du navigateur
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- Télécharger ce dépôt - Télécharger ce dépôt
- Glisser le fichier `log.txt` dans le dossier `/build` - Glisser le fichier `log.txt` dans le dossier `/build`
- Démarrer `/build/index.html` - 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. - 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.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 Comment recompiler la build du rapport? ### 🏭 Comment recompiler la build du rapport?
- Télécharger ce dépôt - Télécharger ce dépôt
- Exécuter `npm install` - Exécuter `npm install`
- Exécuter `npm run build:local` - Exécuter `npm run build:local`
- La dernière build sera dans le dossier `/build` - La dernière build sera dans le dossier `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ Comment voir le compte rendu pour un groupe de microservices? ### 🗃️ 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.) - générer un fichier pour chaque microservice `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Voir “Comment voir le rapport en ligne?”. Au dernier pas, glisser tous les fichiers dans la fenêtre du navigateur. - Voir “Comment voir le rapport en ligne?”. Au dernier pas, glisser tous les fichiers dans la fenêtre du navigateur.
- 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`). - 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`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 Comment apposer une marque sur l’interface? ### 🎨 Comment apposer une marque sur l’interface?
Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer : 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``` - **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. - **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``` - **Langue**. Vous pouvez l’indiquer dans le paramètre d’URL ```lang```. Par exemple: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 Comment signer les commits ? ### 📝 Comment signer les commits ?
Suivez la pratique [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Par exemple: Suivez la pratique [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Par exemple:
``` ```
@ -137,9 +150,9 @@ JIRA-1234 feat(profile): Added avatar for user
- type de travail `(feat, fix, style, refactor, test, doc etc.)` - type de travail `(feat, fix, style, refactor, test, doc etc.)`
- ficha `(profile - la section du site, la page ou la nouvelle fonctionnalité, en un mot)` - ficha `(profile - la section du site, la page ou la nouvelle fonctionnalité, en un mot)`
- quel problème ont-ils résolu `(Added avatar for user)` - quel problème ont-ils résolu `(Added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -150,7 +163,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -162,26 +175,26 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 Comment automatiser la collecte de données?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 Comment automatiser la collecte de données?
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Sans back-end #### Sans back-end
- clonez le dépôt que vous voulez ; - clonez le dépôt que vous voulez ;
- copiez le dossier `build`; - copiez le dossier `build`;
- Ouvrez `build/index.html` dans le navigateur et ajoutez-le aux favoris; - 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. - 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.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Serveur public #### 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://assayo.online/). Tout simplement, indiquez l’adresse où se trouvent les données dans le paramètre de l’URL ```dump```: 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://assayo.online/). Tout simplement, indiquez l’adresse où se trouvent les données dans le paramètre de l’URL ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Serveur privé #### Serveur privé
- télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo); - télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- Soulevez-le sur le réseau local; - Soulevez-le sur le réseau local;
@ -192,23 +205,23 @@ assayo_url - URL Conteneur assayo, écoute le port 80;
you_url - URL адресс Adresse de votre conteneur de logs git; 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. 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.
<a name="link-26"></a> <a name="link-27"></a>
#### Mise à jour de l’image-Docker #### Mise à jour de l’image-Docker
- constuire la build ```npm run build:docker``` - constuire la build ```npm run build:docker```
- assembler l'image ```docker build -t assayo .``` - assembler l'image ```docker build -t assayo .```
- vérifier visuellement l'image ```docker run --name assayo -p 80:80 -d assayo```; - vérifier visuellement l'image ```docker run --name assayo -p 80:80 -d assayo```;
- mettre la balise ```docker tag assayo bakhirev/assayo:latest```; - mettre la balise ```docker tag assayo bakhirev/assayo:latest```;
- Envoyer le code au référentiel d'images dans Docker Hub ```docker push bakhirev/assayo:latest```; - Envoyer le code au référentiel d'images dans Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 Les versions sont publiées environ tous les six mois. Quoi de neuf: #### 🈯 Les versions sont publiées environ tous les six mois. Quoi de neuf:
- plus de conseils et de succès; - plus de conseils et de succès;
- résultats de l’année / du mois, impression des rapports; - résultats de l’année / du mois, impression des rapports;
@ -216,11 +229,11 @@ Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne foncti
- analyse des fichiers; - analyse des fichiers;
- différents rôles pour la statistique (cacher la finance); - différents rôles pour la statistique (cacher la finance);
- développement du backend, intégrations avec d’autres systèmes; - développement du backend, intégrations avec d’autres systèmes;
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ Comment ajouter ou modifier une traduction? #### 🗺️ Comment ajouter ou modifier une traduction?
Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```. Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```.
[Instruction](https://github.com/firstcontributions/first-contributions) [Instruction](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Souhaits, suggestions, commentaires #### 📧 Souhaits, suggestions, commentaires
- telegramm [@bakhirev](https://t.me/bakhirev) (voie de communication prioritaire) - telegramm [@bakhirev](https://t.me/bakhirev) (voie de communication prioritaire)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/JA.md
View file

@ -32,33 +32,34 @@
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [コミット数を素早く確認するにはどうすればよいでしょうか。](#link-4) - [コミット数を素早く確認するにはどうすればよいでしょうか。](#link-4)
- [作者をまとめるにはどうすればいいですか？](#link-5) - [How to create a report?](#link-5)
- [Gitからデータをダウンロードするにはどうすればよろしいでしょうか。](#link-6) - [作者をまとめるにはどうすればいいですか？](#link-6)
- [Дオンラインで見るため](#link-7) - [Gitからデータをダウンロードするにはどうすればよろしいでしょうか。](#link-7)
- [インターネットなしで見るために](#link-8) - [Дオンラインで見るため](#link-8)
- [If you use PowerShell in Windows](#link-9) - [インターネットなしで見るために](#link-9)
- [レポートを表示するにはどうすればよいですか？ ](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [レポートを表示するにはどうすればよいですか？ ](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [レポートファイルを再構成する方法は？](#link-13) - [Offline](#link-13)
- [マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。](#link-14) - [レポートファイルを再構成する方法は？](#link-14)
- [自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。](#link-15) - [マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。](#link-15)
- [commit文の署名方法は？](#link-16) - [自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。](#link-16)
- [How to add checking for commit message?](#link-17) - [commit文の署名方法は？](#link-17)
- [ Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [ Use package pre-commit](#link-19) - [ Use file commit-msg](#link-19)
- [データの自動収集方法は？](#link-20) - [ Use package pre-commit](#link-20)
- [With backend](#link-21) - [データの自動収集方法は？](#link-21)
- [バックエンドなし](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [バックエンドなし](#link-23)
- [公開サーバ](#link-24) - [DevOps ](#link-24)
- [プライベートサーバー](#link-25) - [公開サーバ](#link-25)
- [Dockerイメージの更新](#link-26) - [プライベートサーバー](#link-26)
- [️ About application](#link-27) - [Dockerイメージの更新](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [半年ごとにリリースを行います。次は何でしょうか。](#link-29) - [Architecture](#link-29)
- [翻訳を追加または編集するにはどうすればいいでしょうか。](#link-30) - [半年ごとにリリースを行います。次は何でしょうか。](#link-30)
- [願い、提案、コメント](#link-31) - [翻訳を追加または編集するにはどうすればいいでしょうか。](#link-31)
- [願い、提案、コメント](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 コミット数を素早く確認するにはどうすればよいでしょうか。 ### 🚀 コミット数を素早く確認するにはどうすればよいでしょうか。
プロジェクトのルートディレクトリで以下のコマンドを実行します: プロジェクトのルートディレクトリで以下のコマンドを実行します:
@ -66,6 +67,18 @@
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 作者をまとめるにはどうすればいいですか？ ### ‍🎭 作者をまとめるにはどうすればいいですか？
プロジェクトのルートディレクトリ内に.mailmapファイルを作成する必要があります。 プロジェクトのルートディレクトリ内に.mailmapファイルを作成する必要があります。
ファイルの内容の例: ファイルの内容の例:
@ -76,59 +89,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
このファイルの形式について詳しく読むことができます [ここに](https://git-scm.com/docs/gitmailmap). このファイルの形式について詳しく読むことができます [ここに](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Gitからデータをダウンロードするにはどうすればよろしいでしょうか。
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Gitからデータをダウンロードするにはどうすればよろしいでしょうか。
<a name="link-8"></a>
#### Дオンラインで見るため #### Дオンラインで見るため
プロジェクトのルートディレクトリに次のコマンドを入力します: プロジェクトのルートディレクトリに次のコマンドを入力します:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### インターネットなしで見るために #### インターネットなしで見るために
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Gitはファイルを作成します `log.txt`. このファイルには、レポートを構築するためのデータが含まれています。 インターネットのない形式とインターネットのある形式は、文字列が埋め込まれているという点で異なります。インターネットを持たない形式でファイルを開くと、単に「js」ファイルとして読み込まれます。 `/build/index.html` Gitはファイルを作成します `log.txt`. このファイルには、レポートを構築するためのデータが含まれています。 インターネットのない形式とインターネットのある形式は、文字列が埋め込まれているという点で異なります。インターネットを持たない形式でファイルを開くと、単に「js」ファイルとして読み込まれます。 `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 レポートを表示するにはどうすればよいですか？
<a name="link-11"></a> <a name="link-11"></a>
### 📈 レポートを表示するにはどうすればよいですか？
<a name="link-12"></a>
#### Online #### Online
- に切り替える [ウェブサイト](https://assayo.online/) - に切り替える [ウェブサイト](https://assayo.online/)
- ボタンを押す “[デモ](https://assayo.online/demo?lang=ru)” - ボタンを押す “[デモ](https://assayo.online/demo?lang=ru)”
- ファイルをドラッグ＆ドロップする `log.txt` ブラウザウィンドウで - ファイルをドラッグ＆ドロップする `log.txt` ブラウザウィンドウで
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- このリポジトリをダウンロードする - このリポジトリをダウンロードする
- ファイルをドラッグ＆ドロップする `log.txt` フォルダへ `/build` - ファイルをドラッグ＆ドロップする `log.txt` フォルダへ `/build`
- 実行するには `/build/index.html` - 実行するには `/build/index.html`
- フォルダをドラッグして下さい `/build` 自分のリポジトリーにフォルダを置いてください (それがある場所 `log.txt`). 名前を変更することができます。例えば名前 `/build` を `/report` - フォルダをドラッグして下さい `/build` 自分のリポジトリーにフォルダを置いてください (それがある場所 `log.txt`). 名前を変更することができます。例えば名前 `/build` を `/report`
重要なのは、ファイル `log.txt` インターネットが利用できない環境で、レポートを表示するために作成されたコマンドである必要があります。 重要なのは、ファイル `log.txt` インターネットが利用できない環境で、レポートを表示するために作成されたコマンドである必要があります。
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 レポートファイルを再構成する方法は？ ### 🏭 レポートファイルを再構成する方法は？
- このリポジトリをダウンロードしてください - このリポジトリをダウンロードしてください
- 実行するには `npm install` - 実行するには `npm install`
- 実行するには `npm run build:local` - 実行するには `npm run build:local`
- 最新のビルドは、フォルダに含まれるでしょう `/build` - 最新のビルドは、フォルダに含まれるでしょう `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。 ### 🗃️ マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。
- マイクロサービスごとにファイルを作成します。 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` など。) - マイクロサービスごとにファイルを作成します。 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` など。)
- "インターネット上でレポートを見る方法"を参照してください。最後の手順では、すべてのファイルをブラウザのウィンドウに一度にドラッグ＆ドロップします。 - "インターネット上でレポートを見る方法"を参照してください。最後の手順では、すべてのファイルをブラウザのウィンドウに一度にドラッグ＆ドロップします。
- “インターネットなしでレポートを見る方法” を参照してください。第二段階では、マイクロサービスのすべてのファイルをドラッグしてドロップする必要があります。(`log-1.txt`, `log-2.txt`, `log-3.txt` など。) レポートフォルダへ (`/build`). - “インターネットなしでレポートを見る方法” を参照してください。第二段階では、マイクロサービスのすべてのファイルをドラッグしてドロップする必要があります。(`log-1.txt`, `log-2.txt`, `log-3.txt` など。) レポートフォルダへ (`/build`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。 ### 🎨 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。
インターフェースのテーマを独自に作成することができます。下記の項目は変更できます。 インターフェースのテーマを独自に作成することができます。下記の項目は変更できます。
- **見出し**. それはURLパラメータで指定することができます ```title```. 例えば: ```?title=You Company``` - **見出し**. それはURLパラメータで指定することができます ```title```. 例えば: ```?title=You Company```
- **CSS スタイル**. そのためにはCSSファイルを用意し、そのアドレスをURLパラメーターに指定する必要があります ```theme```. 例えば: ```?theme=//company.com/some.css```. クラス名をセレクターとして使用することができます。ほとんどの場合、新しいバージョンがリリースされると変更されません - **CSS スタイル**. そのためにはCSSファイルを用意し、そのアドレスをURLパラメーターに指定する必要があります ```theme```. 例えば: ```?theme=//company.com/some.css```. クラス名をセレクターとして使用することができます。ほとんどの場合、新しいバージョンがリリースされると変更されません
- **言語**. URLパラメータに指定することができます ```lang```. 例えば: ```?lang=es``` - **言語**. URLパラメータに指定することができます ```lang```. 例えば: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 commit文の署名方法は？ ### 📝 commit文の署名方法は？
練習に従ってください [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例えば: 練習に従ってください [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例えば:
``` ```
@ -138,9 +151,9 @@ JIRA-1234 feat(profile): Added avatar for user
- 仕事の種類 `(feat, fix, style, refactor, test, doc など。)` - 仕事の種類 `(feat, fix, style, refactor, test, doc など。)`
- 仕事の分野 `(profile - サイトのセクション、ページ、新機能、簡単に)` - 仕事の分野 `(profile - サイトのセクション、ページ、新機能、簡単に)`
- ジョブの説明 `(Added avatar for user)` - ジョブの説明 `(Added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -151,7 +164,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -163,27 +176,27 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 データの自動収集方法は？
<a name="link-21"></a> <a name="link-21"></a>
### 📚 データの自動収集方法は？
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### バックエンドなし #### バックエンドなし
- リポジトリのクローンを作成します。; - リポジトリのクローンを作成します。;
- フォルダをコピーする `build` 現在のリポジトリから; - フォルダをコピーする `build` 現在のリポジトリから;
- オープン `build/index.html` ブラウザでブックマークに追加します。; - オープン `build/index.html` ブラウザでブックマークに追加します。;
- にショートカットを追加する `build/assets/ci-cd.sh` 自動起動フォルダーに (Windows); - にショートカットを追加する `build/assets/ci-cd.sh` 自動起動フォルダーに (Windows);
コンピューターを再起動するとき、スクリプトはメインブランチに自動的に挿入されたすべてのデータについての統計を更新します。 コンピューターを再起動するとき、スクリプトはメインブランチに自動的に挿入されたすべてのデータについての統計を更新します。
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### 公開サーバ #### 公開サーバ
データをレポートビルド用に公開するファイルをURLで公開することができます。その視覚化は、サイト上で利用可能なツールを使用することで行うことができます。 [assayo](https://assayo.online/). データがある場所のアドレスを、URLパラメータに入力してください。 ```dump```: データをレポートビルド用に公開するファイルをURLで公開することができます。その視覚化は、サイト上で利用可能なツールを使用することで行うことができます。 [assayo](https://assayo.online/). データがある場所のアドレスを、URLパラメータに入力してください。 ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### プライベートサーバー #### プライベートサーバー
- ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo); - ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo);
- ローカルネットワーク内で実行します。; - ローカルネットワーク内で実行します。;
@ -194,30 +207,30 @@ assayo_url - ポート80でリッスンしているassayoコンテナのURL;
you_url - gitのログのコンテナーのURLアドレス; you_url - gitのログのコンテナーのURLアドレス;
``` ```
デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。 デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。
<a name="link-26"></a> <a name="link-27"></a>
#### Dockerイメージの更新 #### Dockerイメージの更新
- 次のコマンドを実行します ```npm run build:docker``` - 次のコマンドを実行します ```npm run build:docker```
- 次のコマンドを実行します ```docker build -t assayo .``` - 次のコマンドを実行します ```docker build -t assayo .```
- 結果を確認する ```docker run --name assayo -p 80:80 -d assayo```; - 結果を確認する ```docker run --name assayo -p 80:80 -d assayo```;
- 次のコマンドを実行します ```docker tag assayo bakhirev/assayo:latest```; - 次のコマンドを実行します ```docker tag assayo bakhirev/assayo:latest```;
- コンテナイメージをDocker Hubにアップロードする ```docker push bakhirev/assayo:latest```; - コンテナイメージをDocker Hubにアップロードする ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 半年ごとにリリースを行います。次は何でしょうか。 #### 🈯 半年ごとにリリースを行います。次は何でしょうか。
見て！ [主なドキュメント](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) 見て！ [主なドキュメント](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ 翻訳を追加または編集するにはどうすればいいでしょうか。 #### 🗺️ 翻訳を追加または編集するにはどうすればいいでしょうか。
新しい翻訳を追加するか、現在の翻訳を修正するために、以下のセクションでそれを行うことができます: ```ts/translations/```. 新しい翻訳を追加するか、現在の翻訳を修正するために、以下のセクションでそれを行うことができます: ```ts/translations/```.
[取扱説明書](https://github.com/firstcontributions/first-contributions) [取扱説明書](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 願い、提案、コメント #### 📧 願い、提案、コメント
- telegramm [@bakhirev](https://t.me/bakhirev) (優先通信方式) - telegramm [@bakhirev](https://t.me/bakhirev) (優先通信方式)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/PT.md
View file

@ -32,33 +32,34 @@ Visualização e análise de dados do seu repositório git ([demonstração](htt
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [Como é rápido ver o número de commits?](#link-4) - [Como é rápido ver o número de commits?](#link-4)
- [Como combinar os autores?](#link-5) - [How to create a report?](#link-5)
- [Como exportar dados do git? ](#link-6) - [Como combinar os autores?](#link-6)
- [Para visualização online](#link-7) - [Como exportar dados do git? ](#link-7)
- [Para ver sem internet](#link-8) - [Para visualização online](#link-8)
- [If you use PowerShell in Windows](#link-9) - [Para ver sem internet](#link-9)
- [Como ver o relatório?](#link-10) - [If you use PowerShell in Windows](#link-10)
- [Online](#link-11) - [Como ver o relatório?](#link-11)
- [Offline](#link-12) - [Online](#link-12)
- [Como recompilar o arquivo do relatório?](#link-13) - [Offline](#link-13)
- [Como visualizar o relatório do grupo de microserviços?](#link-14) - [Como recompilar o arquivo do relatório?](#link-14)
- [Como alterar as cores da interface para as cores da sua marca?](#link-15) - [Como visualizar o relatório do grupo de microserviços?](#link-15)
- [Como faço para assinar commits?](#link-16) - [Como alterar as cores da interface para as cores da sua marca?](#link-16)
- [How to add checking for commit message?](#link-17) - [Como faço para assinar commits?](#link-17)
- [ Use file commit-msg](#link-18) - [How to add checking for commit message?](#link-18)
- [ Use package pre-commit](#link-19) - [ Use file commit-msg](#link-19)
- [Como automatizar a coleta de dados?](#link-20) - [ Use package pre-commit](#link-20)
- [With backend](#link-21) - [Como automatizar a coleta de dados?](#link-21)
- [Sem backend](#link-22) - [With backend](#link-22)
- [DevOps ](#link-23) - [Sem backend](#link-23)
- [Servidor Público](#link-24) - [DevOps ](#link-24)
- [Servidor Privado](#link-25) - [Servidor Público](#link-25)
- [Atualizar a imagem Docker](#link-26) - [Servidor Privado](#link-26)
- [️ About application](#link-27) - [Atualizar a imagem Docker](#link-27)
- [Architecture](#link-28) - [️ About application](#link-28)
- [Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:](#link-29) - [Architecture](#link-29)
- [Como adicionar ou editar uma tradução?](#link-30) - [Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:](#link-30)
- [Sugestões, sugestões, comentários](#link-31) - [Como adicionar ou editar uma tradução?](#link-31)
- [Sugestões, sugestões, comentários](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 Como é rápido ver o número de commits? ### 🚀 Como é rápido ver o número de commits?
No diretório raiz do seu projeto, execute o comando: No diretório raiz do seu projeto, execute o comando:
@ -66,6 +67,18 @@ No diretório raiz do seu projeto, execute o comando:
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 Como combinar os autores? ### ‍🎭 Como combinar os autores?
É necessário criar um arquivo no diretório principal do seu projeto `.mailmap`. É necessário criar um arquivo no diretório principal do seu projeto `.mailmap`.
Exemplo de conteúdo de arquivo: Exemplo de conteúdo de arquivo:
@ -76,59 +89,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Pode ler mais sobre o formato deste arquivo em [aqui](https://git-scm.com/docs/gitmailmap). Pode ler mais sobre o formato deste arquivo em [aqui](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Como exportar dados do git?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Como exportar dados do git?
<a name="link-8"></a>
#### Para visualização online #### Para visualização online
No diretório raiz do seu projeto executar: No diretório raiz do seu projeto executar:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### Para ver sem internet #### Para ver sem internet
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git criar um ficheiro `log.txt`. Esse arquivo contém dados para construção de relatórios. A diferença entre os formatos está na existência de uma envoltória para as linhas. O formato sem internet será puxado como `js` o arquivo se você o abriu simplesmente `/build/index.html` Git criar um ficheiro `log.txt`. Esse arquivo contém dados para construção de relatórios. A diferença entre os formatos está na existência de uma envoltória para as linhas. O formato sem internet será puxado como `js` o arquivo se você o abriu simplesmente `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### 📈 Como ver o relatório?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 Como ver o relatório?
<a name="link-12"></a>
#### Online #### Online
- Ir para [site](https://assayo.online/) - Ir para [site](https://assayo.online/)
- Pressione o botão “[Demonstração](https://assayo.online/demo?lang=ru)” - Pressione o botão “[Demonstração](https://assayo.online/demo?lang=ru)”
- Arrastar e largar `log.txt` na janela do navegador - Arrastar e largar `log.txt` na janela do navegador
<a name="link-12"></a> <a name="link-13"></a>
#### Offline #### Offline
- Baixar este repositório - Baixar este repositório
- Arraste o arquivo `log.txt` para a pasta `/build` - Arraste o arquivo `log.txt` para a pasta `/build`
- Lançar `/build/index.html` - Lançar `/build/index.html`
- Ou arraste a pasta `/build` ir para o repositório (o lugar onde se encontra `log.txt`). Você pode mudar o nome. Por exemplo, do nome `/build` no título `/report` - Ou arraste a pasta `/build` ir para o repositório (o lugar onde se encontra `log.txt`). Você pode mudar o nome. Por exemplo, do nome `/build` no título `/report`
É importante que o arquivo `log.txt` foi criado por uma equipe para navegar sem internet. É importante que o arquivo `log.txt` foi criado por uma equipe para navegar sem internet.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 Como recompilar o arquivo do relatório? ### 🏭 Como recompilar o arquivo do relatório?
- Baixar este repositório - Baixar este repositório
- Executar `npm install` - Executar `npm install`
- Executar `npm run build:local` - Executar `npm run build:local`
- A compilação mais recente estará na pasta `/build` - A compilação mais recente estará na pasta `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ Como visualizar o relatório do grupo de microserviços? ### 🗃️ Como visualizar o relatório do grupo de microserviços?
- Gerar um arquivo para cada microserviço `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) - Gerar um arquivo para cada microserviço `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.)
- Veja “Como visualizar o relatório com a internet?”. No último passo, arraste todos os arquivos para a janela do navegador. - Veja “Como visualizar o relatório com a internet?”. No último passo, arraste todos os arquivos para a janela do navegador.
- Veja “Como visualizar o relatório sem a internet?”. No segundo passo, arraste todos os microserviços (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) na pasta relatório (`/build`). - Veja “Como visualizar o relatório sem a internet?”. No segundo passo, arraste todos os microserviços (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) na pasta relatório (`/build`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 Como alterar as cores da interface para as cores da sua marca? ### 🎨 Como alterar as cores da interface para as cores da sua marca?
Você pode escrever seu próprio tema de interface. Pode mudar: Você pode escrever seu próprio tema de interface. Pode mudar:
- **Cabeçalho**. Você pode especificar em um parâmetro da URL ```title```. Por exemplo: ```?title=You Company``` - **Cabeçalho**. Você pode especificar em um parâmetro da URL ```title```. Por exemplo: ```?title=You Company```
- **CSS стили**. Para fazer isso, você precisa preparar um arquivo CSS e especificar o seu endereço no parâmetro da URL ```theme```. Por exemplo: ```?theme=//company.com/some.css```. Você pode usar os nomes das classes como seletores. A maioria deles não muda na saída de uma nova versão. - **CSS стили**. Para fazer isso, você precisa preparar um arquivo CSS e especificar o seu endereço no parâmetro da URL ```theme```. Por exemplo: ```?theme=//company.com/some.css```. Você pode usar os nomes das classes como seletores. A maioria deles não muda na saída de uma nova versão.
- **Idioma**. Você pode incluir em um parâmetro de URL. ```lang```. Por exemplo: ```?lang=es``` - **Idioma**. Você pode incluir em um parâmetro de URL. ```lang```. Por exemplo: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 Como faço para assinar commits? ### 📝 Como faço para assinar commits?
Siga a prática [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por exemplo: Siga a prática [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por exemplo:
``` ```
@ -138,9 +151,9 @@ JIRA-1234 feat(profile): Added avatar for user
- tipo de trabalho `(feat, fix, style, refactor, test, doc etc.)` - tipo de trabalho `(feat, fix, style, refactor, test, doc etc.)`
- área de trabalho `(profile - Página)` - área de trabalho `(profile - Página)`
- descrição do trabalho `(Added avatar for user)` - descrição do trabalho `(Added avatar for user)`
<a name="link-17"></a>
### 👮 How to add checking for commit message?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 How to add checking for commit message?
<a name="link-19"></a>
#### Use file `commit-msg` #### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -151,7 +164,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -163,27 +176,27 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-20"></a>
### 📚 Como automatizar a coleta de dados?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 Como automatizar a coleta de dados?
<a name="link-22"></a>
#### With backend #### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Sem backend #### Sem backend
- criar um clone do seu repositório; - criar um clone do seu repositório;
- copie a pasta `build` do repositório atual; - copie a pasta `build` do repositório atual;
- abrir `build/index.html` no navegador e adicionar aos favoritos; - abrir `build/index.html` no navegador e adicionar aos favoritos;
- adicionar um shortcut na `build/assets/ci-cd.sh` na pasta de inicialização (Windows); - adicionar um shortcut na `build/assets/ci-cd.sh` na pasta de inicialização (Windows);
A cada reinício do computador, o script atualiza a estatística com todos os dados que sejam automaticamente incorporados na branch principal. A cada reinício do computador, o script atualiza a estatística com todos os dados que sejam automaticamente incorporados na branch principal.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Servidor Público #### Servidor Público
Você pode disponibilizar o arquivo com os dados para construção do relatório em um URL público. Para visualizá-lo, você pode usar um site [assayo](https://assayo.online/). Especifique o endereço onde os dados estão localizados no parâmetro de URL ```dump```: Você pode disponibilizar o arquivo com os dados para construção do relatório em um URL público. Para visualizá-lo, você pode usar um site [assayo](https://assayo.online/). Especifique o endereço onde os dados estão localizados no parâmetro de URL ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Servidor Privado #### Servidor Privado
- baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo); - baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo);
- execute-o na rede local; - execute-o na rede local;
@ -194,30 +207,30 @@ assayo_url - O URL do endereço do container Assay, ele está escutando na porta
you_url - O URL do seu container com os logs do git; you_url - O URL do seu container com os logs do git;
``` ```
Por padrão, a imagem será iniciada no endereço ```http://127.0.0.1:80/```. Se você não conseguiu, verifique se a porta 80 está disponível no seu computador. Por padrão, a imagem será iniciada no endereço ```http://127.0.0.1:80/```. Se você não conseguiu, verifique se a porta 80 está disponível no seu computador.
<a name="link-26"></a> <a name="link-27"></a>
#### Atualizar a imagem Docker #### Atualizar a imagem Docker
- executar um comando ```npm run build:docker``` - executar um comando ```npm run build:docker```
- executar um comando ```docker build -t assayo .``` - executar um comando ```docker build -t assayo .```
- verificar o resultado ```docker run --name assayo -p 80:80 -d assayo```; - verificar o resultado ```docker run --name assayo -p 80:80 -d assayo```;
- executar um comando ```docker tag assayo bakhirev/assayo:latest```; - executar um comando ```docker tag assayo bakhirev/assayo:latest```;
- enviar a imagem do container para o Docker Hub ```docker push bakhirev/assayo:latest```; - enviar a imagem do container para o Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ About application
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ About application
<a name="link-29"></a>
#### 📐 Architecture #### 📐 Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 Liberações, aproximadamente, uma vez por semestre. O que vem a seguir: #### 🈯 Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:
Vide [documentação básica](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) Vide [documentação básica](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ Como adicionar ou editar uma tradução? #### 🗺️ Como adicionar ou editar uma tradução?
Você pode adicionar uma nova tradução ou corrigir uma existente na seção ```ts/translations/```. Você pode adicionar uma nova tradução ou corrigir uma existente na seção ```ts/translations/```.
[Instrução](https://github.com/firstcontributions/first-contributions) [Instrução](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Sugestões, sugestões, comentários #### 📧 Sugestões, sugestões, comentários
- telegramm [@bakhirev](https://t.me/bakhirev) (método de comunicação prioritário) - telegramm [@bakhirev](https://t.me/bakhirev) (método de comunicação prioritário)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

119
documents/RU.md
View file

@ -31,33 +31,34 @@
<a name="link-3"></a> <a name="link-3"></a>
### Содержание ### Содержание
- [Как быстро посмотреть количество коммитов?](#link-4) - [Как быстро посмотреть количество коммитов?](#link-4)
- [Как объединить авторов?](#link-5) - [Как создать отчёт?](#link-5)
- [Как выгрузить данные из git?](#link-6) - [Как объединить авторов?](#link-6)
- [Для онлайн просмотра](#link-7) - [Как выгрузить данные из git?](#link-7)
- [Для офлайн просмотра](#link-8) - [Для онлайн просмотра](#link-8)
- [Если вы используете PowerShell в Windows](#link-9) - [Для офлайн просмотра](#link-9)
- [Как посмотреть отчёт? ](#link-10) - [Если вы используете PowerShell в Windows](#link-10)
- [Онлайн](#link-11) - [Как посмотреть отчёт?](#link-11)
- [Офлайн](#link-12) - [Онлайн](#link-12)
- [Как пересобрать файл отчёта из исходного кода?](#link-13) - [Офлайн](#link-13)
- [Как посмотреть отчёт по группе микросервисов?](#link-14) - [Как пересобрать файл отчёта из исходного кода?](#link-14)
- [Как брендировать интерфейс?](#link-15) - [Как посмотреть отчёт по группе микросервисов?](#link-15)
- [Как подписывать коммиты?](#link-16) - [Как брендировать интерфейс?](#link-16)
- [Как добавить проверку текста коммита?](#link-17) - [Как подписывать коммиты?](#link-17)
- [Используя файл commit-msg](#link-18) - [Как добавить проверку текста коммита?](#link-18)
- [Используя пакет pre-commit](#link-19) - [Используя файл commit-msg](#link-19)
- [Как автоматизировать сбор данных?](#link-20) - [Используя пакет pre-commit](#link-20)
- [С бекендом](#link-21) - [Как автоматизировать сбор данных?](#link-21)
- [Без бекенда](#link-22) - [С бекендом](#link-22)
- [DevOps ](#link-23) - [Без бекенда](#link-23)
- [Публичный сервер](#link-24) - [DevOps ](#link-24)
- [Приватный сервер](#link-25) - [Публичный сервер](#link-25)
- [Обновление Docker-образа](#link-26) - [Приватный сервер](#link-26)
- [️ О приложении](#link-27) - [Обновление Docker-образа](#link-27)
- [Архитектура](#link-28) - [️ О приложении](#link-28)
- [Релизы, примерно, раз в полгода. Что дальше:](#link-29) - [Архитектура](#link-29)
- [Как добавить или отредактировать перевод?](#link-30) - [Релизы, примерно, раз в полгода. Что дальше:](#link-30)
- [Пожелания, предложения, замечания](#link-31) - [Как добавить или отредактировать перевод?](#link-31)
- [Пожелания, предложения, замечания](#link-32)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 Как быстро посмотреть количество коммитов? ### 🚀 Как быстро посмотреть количество коммитов?
В корневой директории вашего проекта выполнить: В корневой директории вашего проекта выполнить:
@ -65,6 +66,18 @@
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 Как создать отчёт?
Если у вас установлен NodeJS, то вы можете выполнить:
```
npx assayo
```
Скрипт создаст папку `./assayo` с отчётом по данному репозиторию:
```
./assayo/index.html - отчёт
./assayo/log.txt - информация полученная из git log
```
Если NodeJS у вас не установлен, тогда см. пункты «Как выгрузить данные из git?» и «Как посмотреть отчёт?»
<a name="link-6"></a>
### ‍🎭 Как объединить авторов? ### ‍🎭 Как объединить авторов?
В корневой директории вашего проекта нужно создать файл `.mailmap`. В корневой директории вашего проекта нужно создать файл `.mailmap`.
Пример содержания файла: Пример содержания файла:
@ -75,59 +88,59 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap). Подробнее про формат этого файла можно прочитать [тут](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 Как выгрузить данные из git?
<a name="link-7"></a> <a name="link-7"></a>
### 📤 Как выгрузить данные из git?
<a name="link-8"></a>
#### Для онлайн просмотра #### Для онлайн просмотра
В корневой директории вашего проекта выполнить: В корневой директории вашего проекта выполнить:
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### Для офлайн просмотра #### Для офлайн просмотра
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git создаст файл `log.txt`. Он содержит данные для построения отчёта. Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html` Git создаст файл `log.txt`. Он содержит данные для построения отчёта. Разница между онлайн и офлайн форматом в наличие обёртки для строк. Оффлайн формат будет подтягиваться, как `js` файл если вы просто открыли `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### Если вы используете PowerShell в Windows #### Если вы используете PowerShell в Windows
По умолчанию, поток вывода не совпадает с UTF-8 и итоговый файл становится нечитаемым. Перед сохранением файла с логом вы можете изменить кодировку командой: По умолчанию, поток вывода не совпадает с UTF-8 и итоговый файл становится нечитаемым. Перед сохранением файла с логом вы можете изменить кодировку командой:
``` ```
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Или откройте сохраненный файл и вручную измените кодировку на UTF-8. Или откройте сохраненный файл и вручную измените кодировку на UTF-8.
<a name="link-10"></a>
### 📈 Как посмотреть отчёт?
<a name="link-11"></a> <a name="link-11"></a>
### 📈 Как посмотреть отчёт?
<a name="link-12"></a>
#### Онлайн #### Онлайн
- Перейти на [сайт](https://assayo.online/) - Перейти на [сайт](https://assayo.online/)
- Нажать кнопку «[Демо](https://assayo.online/demo?ref=github&lang=ru)» - Нажать кнопку «[Демо](https://assayo.online/demo?ref=github&lang=ru)»
- Перетащить файл `log.txt` в окно браузера - Перетащить файл `log.txt` в окно браузера
<a name="link-12"></a> <a name="link-13"></a>
#### Офлайн #### Офлайн
- Скачать этот репозиторий - Скачать этот репозиторий
- Перетащить файл `log.txt` в папку `/build` - Перетащить файл `log.txt` в папку `/build`
- Запустить `/build/index.html` - Запустить `/build/index.html`
- Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report` - Или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report`
В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра. В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра.
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 Как пересобрать файл отчёта из исходного кода? ### 🏭 Как пересобрать файл отчёта из исходного кода?
- Скачать этот репозиторий - Скачать этот репозиторий
- Выполнить `npm install` - Выполнить `npm install`
- Выполнить `npm run build:local` - Выполнить `npm run build:local`
- Свежая сборка будет в папке `/build` - Свежая сборка будет в папке `/build`
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ Как посмотреть отчёт по группе микросервисов? ### 🗃️ Как посмотреть отчёт по группе микросервисов?
- Сгенерировать для каждого микросервиса файл `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.). Вы можете сделать это в ручную, или использовать модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) для автоматического сбора логов; - Сгенерировать для каждого микросервиса файл `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`). - См. «Как посмотреть отчёт офлайн?». На втором шаге перетащить все файлы микросервисов (`log-1.txt`, `log-2.txt`, `log-3.txt` и т.д.) в папку отчета (`/build`).
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 Как брендировать интерфейс? ### 🎨 Как брендировать интерфейс?
Вы можете написать свою тему для интерфейса. Можно менять: Вы можете написать свою тему для интерфейса. Можно менять:
- **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company``` - **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company```
- **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий. - **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий.
- **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es``` - **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es```
<a name="link-16"></a> <a name="link-17"></a>
### 📝 Как подписывать коммиты? ### 📝 Как подписывать коммиты?
Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например: Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например:
``` ```
@ -137,9 +150,9 @@ JIRA-1234 feat(profile): Added avatar for user
- тип работы `(feat, fix, style, refactor, test, doc и т.д.)` - тип работы `(feat, fix, style, refactor, test, doc и т.д.)`
- фича `(profile - раздел сайта, страница или новый функционал, одним словом)` - фича `(profile - раздел сайта, страница или новый функционал, одним словом)`
- какую проблему решали `(Added avatar for user)` - какую проблему решали `(Added avatar for user)`
<a name="link-17"></a>
### 👮 Как добавить проверку текста коммита?
<a name="link-18"></a> <a name="link-18"></a>
### 👮 Как добавить проверку текста коммита?
<a name="link-19"></a>
#### Используя файл `commit-msg` #### Используя файл `commit-msg`
1. Создайте файл `commit-msg` в папке `.git/hooks/` 1. Создайте файл `commit-msg` в папке `.git/hooks/`
2. Добавьте в файл следующий текст: 2. Добавьте в файл следующий текст:
@ -150,7 +163,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-19"></a> <a name="link-20"></a>
#### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit) #### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Добавьте в файл `package.json` блок `commit-msg`: 1. Добавьте в файл `package.json` блок `commit-msg`:
``` ```
@ -162,27 +175,27 @@ fi
... ...
``` ```
2. Выполните команду `npm install pre-commit` 2. Выполните команду `npm install pre-commit`
<a name="link-20"></a>
### 📚 Как автоматизировать сбор данных?
<a name="link-21"></a> <a name="link-21"></a>
### 📚 Как автоматизировать сбор данных?
<a name="link-22"></a>
#### С бекендом #### С бекендом
- используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-22"></a> <a name="link-23"></a>
#### Без бекенда #### Без бекенда
- создайте клон нужного вам репозитория; - создайте клон нужного вам репозитория;
- скопируйте в корень папку `build`; - скопируйте в корень папку `build`;
- откройте `build/index.html` в браузере и добавьте в закладки; - откройте `build/index.html` в браузере и добавьте в закладки;
- добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows); - добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows);
Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку. Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку.
<a name="link-23"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-24"></a> <a name="link-24"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-25"></a>
#### Публичный сервер #### Публичный сервер
Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```: Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-25"></a> <a name="link-26"></a>
#### Приватный сервер #### Приватный сервер
- скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo); - скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- поднимите его в локальной сети; - поднимите его в локальной сети;
@ -193,23 +206,23 @@ assayo_url - URL адресс контейнера assayo, он слушает 8
you_url - URL адресс вашего контейнера с логами git; you_url - URL адресс вашего контейнера с логами git;
``` ```
По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт. По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт.
<a name="link-26"></a> <a name="link-27"></a>
#### Обновление Docker-образа #### Обновление Docker-образа
- собрать билд ```npm run build:docker``` - собрать билд ```npm run build:docker```
- собрать образ ```docker build -t assayo .``` - собрать образ ```docker build -t assayo .```
- визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```; - визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```;
- поставить тег ```docker tag assayo bakhirev/assayo:latest```; - поставить тег ```docker tag assayo bakhirev/assayo:latest```;
- запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```; - запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-27"></a>
### 🛠️ ️ О приложении
<a name="link-28"></a> <a name="link-28"></a>
### 🛠️ ️ О приложении
<a name="link-29"></a>
#### 📐 Архитектура #### 📐 Архитектура
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев. 1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев.
2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов. 2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов.
3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными.
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 Релизы, примерно, раз в полгода. Что дальше: #### 🈯 Релизы, примерно, раз в полгода. Что дальше:
- больше советов и достижений; - больше советов и достижений;
- итоги года / месяца, печать отчётов; - итоги года / месяца, печать отчётов;
@ -217,11 +230,11 @@ you_url - URL адресс вашего контейнера с логами
- анализ файлов; - анализ файлов;
- разные роли для статистики (скрытие финансов); - разные роли для статистики (скрытие финансов);
- разработка бекенда, интеграции с другими системами; - разработка бекенда, интеграции с другими системами;
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ Как добавить или отредактировать перевод? #### 🗺️ Как добавить или отредактировать перевод?
Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```. Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```.
[Инструкция](https://github.com/firstcontributions/first-contributions) [Инструкция](https://github.com/firstcontributions/first-contributions)
<a name="link-31"></a> <a name="link-32"></a>
#### 📧 Пожелания, предложения, замечания #### 📧 Пожелания, предложения, замечания
- telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи) - telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

115
documents/ZH.md
View file

@ -32,32 +32,33 @@
<a name="link-3"></a> <a name="link-3"></a>
### Table of contents ### Table of contents
- [如何 quickly 查阅 commit 的 次数？](#link-4) - [如何 quickly 查阅 commit 的 次数？](#link-4)
- [如何 combine 作者？](#link-5) - [How to create a report?](#link-5)
- [如何从 git 导出数据？](#link-6) - [如何 combine 作者？](#link-6)
- [供网上浏览](#link-7) - [如何从 git 导出数据？](#link-7)
- [在没有互联网的情况下观看](#link-8) - [供网上浏览](#link-8)
- [If you use PowerShell in Windows](#link-9) - [在没有互联网的情况下观看](#link-9)
- [如何在线查看报告？](#link-10) - [If you use PowerShell in Windows](#link-10)
- [如何在没有网络环境下查看报告？](#link-11) - [如何在线查看报告？](#link-11)
- [如何重打包报告文件？](#link-12) - [如何在没有网络环境下查看报告？](#link-12)
- [如何查看微服务组的报告？](#link-13) - [如何重打包报告文件？](#link-13)
- [如何将界面重新配色为公司专有颜色？](#link-14) - [如何查看微服务组的报告？](#link-14)
- [如何签署提交？](#link-15) - [如何将界面重新配色为公司专有颜色？](#link-15)
- [How to add checking for commit message?](#link-16) - [如何签署提交？](#link-16)
- [ Use file commit-msg](#link-17) - [How to add checking for commit message?](#link-17)
- [ Use package pre-commit](#link-18) - [ Use file commit-msg](#link-18)
- [如何自动化数据采集？](#link-19) - [ Use package pre-commit](#link-19)
- [With backend](#link-20) - [如何自动化数据采集？](#link-20)
- [没有后端](#link-21) - [With backend](#link-21)
- [DevOps ](#link-22) - [没有后端](#link-22)
- [公共服务器](#link-23) - [DevOps ](#link-23)
- [专用服务器](#link-24) - [公共服务器](#link-24)
- [Docker 图像更新](#link-25) - [专用服务器](#link-25)
- [️ About application](#link-26) - [Docker 图像更新](#link-26)
- [Architecture](#link-27) - [️ About application](#link-27)
- [释出版本大约每半年一次。接下来发生什么情况：](#link-28) - [Architecture](#link-28)
- [如何添加或编辑翻译？](#link-29) - [释出版本大约每半年一次。接下来发生什么情况：](#link-29)
- [愿望，建议，意见](#link-30) - [如何添加或编辑翻译？](#link-30)
- [愿望，建议，意见](#link-31)
<a name="link-4"></a> <a name="link-4"></a>
### 🚀 如何 quickly 查阅 commit 的 次数？ ### 🚀 如何 quickly 查阅 commit 的 次数？
在项目的根目录中执行以下命令： 在项目的根目录中执行以下命令：
@ -65,6 +66,18 @@
git shortlog -s -n -e git shortlog -s -n -e
``` ```
<a name="link-5"></a> <a name="link-5"></a>
### 🚀 How to create a report?
If you have NodeJS, you can run:
```
npx assayo
```
The script will create a folder `./assayo` with a report about repository:
```
./assayo/index.html - report
./assayo/log.txt - information from git
```
If you do not have NodeJS , see the items "How to download data from git?" and "How to view the report?"
<a name="link-6"></a>
### ‍🎭 如何 combine 作者？ ### ‍🎭 如何 combine 作者？
在项目的 根目录 创建一个文件 `.mailmap`. 在项目的 根目录 创建一个文件 `.mailmap`.
文件内容示例: 文件内容示例:
@ -75,57 +88,57 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
Alex B <alex@mail.uk> <man64@yahoo.com> Alex B <alex@mail.uk> <man64@yahoo.com>
``` ```
关于这个文件格式的 详情 可以 参考 [这里](https://git-scm.com/docs/gitmailmap). 关于这个文件格式的 详情 可以 参考 [这里](https://git-scm.com/docs/gitmailmap).
<a name="link-6"></a>
### 📤 如何从 git 导出数据？
<a name="link-7"></a> <a name="link-7"></a>
### 📤 如何从 git 导出数据？
<a name="link-8"></a>
#### 供网上浏览 #### 供网上浏览
在项目的根目录执行： 在项目的根目录执行：
``` ```
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" > log.txt
``` ```
<a name="link-8"></a> <a name="link-9"></a>
#### 在没有互联网的情况下观看 #### 在没有互联网的情况下观看
``` ```
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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > 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/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
``` ```
Git会创建一个文件 `log.txt`. 这个文件包含了构建报告的数据。 字符串格式的区别在于它们具有的包装。无网络格式将会像您只是简单地打开了js文件一样被加载。 `/build/index.html` Git会创建一个文件 `log.txt`. 这个文件包含了构建报告的数据。 字符串格式的区别在于它们具有的包装。无网络格式将会像您只是简单地打开了js文件一样被加载。 `/build/index.html`
<a name="link-9"></a> <a name="link-10"></a>
#### If you use PowerShell in Windows #### 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. 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 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8
``` ```
Or open a saved file and manually change the encoding to UTF-8. Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a> <a name="link-11"></a>
### 📈 如何在线查看报告？ ### 📈 如何在线查看报告？
- 切换到 [网站](https://assayo.online/) - 切换到 [网站](https://assayo.online/)
- 按下按钮 “[示范](https://assayo.online/demo?lang=ru)” - 按下按钮 “[示范](https://assayo.online/demo?lang=ru)”
- 拖放文件 `log.txt` 在浏览器窗口中 - 拖放文件 `log.txt` 在浏览器窗口中
<a name="link-11"></a> <a name="link-12"></a>
### 如何在没有网络环境下查看报告？ ### 如何在没有网络环境下查看报告？
- 下载这个存储库 - 下载这个存储库
- 拖放文件 `log.txt` 到文件夹 `/build` - 拖放文件 `log.txt` 到文件夹 `/build`
- 要运行 `/build/index.html` - 要运行 `/build/index.html`
- 或是拖放文件夹 `/build` 到我的仓库 (它所在的地方 `log.txt`). 可以改变名称。比如，从名称 `/build` 到名称 `/report` - 或是拖放文件夹 `/build` 到我的仓库 (它所在的地方 `log.txt`). 可以改变名称。比如，从名称 `/build` 到名称 `/report`
重要的事情是，必须让log.txt这个文件是通过命令创建出来的，这样它就可以在没有网的时候查看了。 重要的事情是，必须让log.txt这个文件是通过命令创建出来的，这样它就可以在没有网的时候查看了。
<a name="link-12"></a> <a name="link-13"></a>
### 如何重打包报告文件？ ### 如何重打包报告文件？
- 下载这个储存库 - 下载这个储存库
- 要执行 `npm install` - 要执行 `npm install`
- 要执行 `npm run build:local` - 要执行 `npm run build:local`
- 最新的构建将在文件夹 `/build` - 最新的构建将在文件夹 `/build`
<a name="link-13"></a> <a name="link-14"></a>
### 🏭 如何查看微服务组的报告？ ### 🏭 如何查看微服务组的报告？
- 为每个微服务生成文件 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) - 为每个微服务生成文件 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等)
- 参见“如何在有网络环境下查看报告”。在最后一步，将所有文件同时拖入浏览器窗口。 - 参见“如何在有网络环境下查看报告”。在最后一步，将所有文件同时拖入浏览器窗口。
- 参见“如何在没有网络环境下查看报告”。第二步将所有微服务文件拖动到 (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) 到报表文件夹 (`/build`). - 参见“如何在没有网络环境下查看报告”。第二步将所有微服务文件拖动到 (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) 到报表文件夹 (`/build`).
<a name="link-14"></a> <a name="link-15"></a>
### 🗃️ 如何将界面重新配色为公司专有颜色？ ### 🗃️ 如何将界面重新配色为公司专有颜色？
您可以为界面创建自己的主题。可以修改： 您可以为界面创建自己的主题。可以修改：
- **标题**. 你可以在网址参数中指定它 ```title```. 例如: ```?title=You Company``` - **标题**. 你可以在网址参数中指定它 ```title```. 例如: ```?title=You Company```
- **CSS样式**. 为了做到这一点，你需要准备一个CSS文件并在网址参数中指明其地址 ```theme```. 例如: ```?theme=//company.com/some.css```. 你可以使用类名作为选择器。大多数情况下，他们在新版本发布时不会发生变化。 - **CSS样式**. 为了做到这一点，你需要准备一个CSS文件并在网址参数中指明其地址 ```theme```. 例如: ```?theme=//company.com/some.css```. 你可以使用类名作为选择器。大多数情况下，他们在新版本发布时不会发生变化。
- **语言**. 你可以把它放在网址的参数中。 ```lang```. 例如: ```?lang=es``` - **语言**. 你可以把它放在网址的参数中。 ```lang```. 例如: ```?lang=es```
<a name="link-15"></a> <a name="link-16"></a>
### 🎨 如何签署提交？ ### 🎨 如何签署提交？
遵循实践 [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例如: 遵循实践 [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例如:
``` ```
@ -135,9 +148,9 @@ JIRA-1234 feat(profile): Added avatar for user
- 工作类别 `(feat, fix, style, refactor, test, doc 等等)` - 工作类别 `(feat, fix, style, refactor, test, doc 等等)`
- 工作领域 `(profile - 地盘组, 网页 或新功能, 一句话)` - 工作领域 `(profile - 地盘组, 网页 或新功能, 一句话)`
- 职位描述 `(Added avatar for user)` - 职位描述 `(Added avatar for user)`
<a name="link-16"></a>
### 📝 How to add checking for commit message?
<a name="link-17"></a> <a name="link-17"></a>
### 📝 How to add checking for commit message?
<a name="link-18"></a>
#### 👮 Use file `commit-msg` #### 👮 Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/` 1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file: 2. Add this text in file:
@ -148,7 +161,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1 exit 1
fi fi
``` ```
<a name="link-18"></a> <a name="link-19"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`: 1. Add in file `package.json` property `commit-msg`:
``` ```
@ -160,27 +173,27 @@ fi
... ...
``` ```
2. Run command `npm install pre-commit` 2. Run command `npm install pre-commit`
<a name="link-19"></a>
### 如何自动化数据采集？
<a name="link-20"></a> <a name="link-20"></a>
### 如何自动化数据采集？
<a name="link-21"></a>
#### 📚 With backend #### 📚 With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-21"></a> <a name="link-22"></a>
#### 没有后端 #### 没有后端
- 克隆您的仓库; - 克隆您的仓库;
- 复制文件夹 `build` 从当前仓库; - 复制文件夹 `build` 从当前仓库;
- 打开 `build/index.html` 在浏览器中添加书签; - 打开 `build/index.html` 在浏览器中添加书签;
- 添加一个快捷方式 `build/assets/ci-cd.sh` 自动启动文件夹 (Windows); - 添加一个快捷方式 `build/assets/ci-cd.sh` 自动启动文件夹 (Windows);
每次重启计算机，该脚本将更新统计数据，这些数据自动添加到主分支中。 每次重启计算机，该脚本将更新统计数据，这些数据自动添加到主分支中。
<a name="link-22"></a>
### DevOps (CI/CD)
<a name="link-23"></a> <a name="link-23"></a>
### DevOps (CI/CD)
<a name="link-24"></a>
#### 🛠️ 公共服务器 #### 🛠️ 公共服务器
您可以将数据构建报告文件发布到公共URL，可以使用网站来显示它。 [assayo](https://assayo.online/). 指定数据所在的地址作为URL参数 ```dump```: 您可以将数据构建报告文件发布到公共URL，可以使用网站来显示它。 [assayo](https://assayo.online/). 指定数据所在的地址作为URL参数 ```dump```:
``` ```
https://assayo.online/demo/?dump=//you_site.com/some/log.txt https://assayo.online/demo/?dump=//you_site.com/some/log.txt
``` ```
<a name="link-24"></a> <a name="link-25"></a>
#### 专用服务器 #### 专用服务器
- 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo); - 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo);
- 在本地网络中运行它; - 在本地网络中运行它;
@ -191,30 +204,30 @@ assayo_url - assayo容器的URL地址，它监听80端口;
you_url - git日志的容器的URL地址; you_url - git日志的容器的URL地址;
``` ```
默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用. 默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用.
<a name="link-25"></a> <a name="link-26"></a>
#### Docker 图像更新 #### Docker 图像更新
- 运行命令 ```npm run build:docker``` - 运行命令 ```npm run build:docker```
- 运行命令 ```docker build -t assayo .``` - 运行命令 ```docker build -t assayo .```
- 检查结果 ```docker run --name assayo -p 80:80 -d assayo```; - 检查结果 ```docker run --name assayo -p 80:80 -d assayo```;
- 运行命令 ```docker tag assayo bakhirev/assayo:latest```; - 运行命令 ```docker tag assayo bakhirev/assayo:latest```;
- 提交容器映像到 Docker Hub ```docker push bakhirev/assayo:latest```; - 提交容器映像到 Docker Hub ```docker push bakhirev/assayo:latest```;
<a name="link-26"></a>
### ️ About application
<a name="link-27"></a> <a name="link-27"></a>
### ️ About application
<a name="link-28"></a>
#### 🛠️ Architecture #### 🛠️ Architecture
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" /> <img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
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. 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. 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. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.
<a name="link-28"></a> <a name="link-29"></a>
#### 📐 释出版本大约每半年一次。接下来发生什么情况： #### 📐 释出版本大约每半年一次。接下来发生什么情况：
看 [主要文件](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) 看 [主要文件](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-29"></a> <a name="link-30"></a>
#### 🈯 如何添加或编辑翻译？ #### 🈯 如何添加或编辑翻译？
您可以在“翻译”部分添加新翻译或更正当前翻译。 ```ts/translations/```. 您可以在“翻译”部分添加新翻译或更正当前翻译。 ```ts/translations/```.
[指示手册](https://github.com/firstcontributions/first-contributions) [指示手册](https://github.com/firstcontributions/first-contributions)
<a name="link-30"></a> <a name="link-31"></a>
#### 🗺️ 愿望，建议，意见 #### 🗺️ 愿望，建议，意见
- telegramm [@bakhirev](https://t.me/bakhirev) (优先通信方法) - telegramm [@bakhirev](https://t.me/bakhirev) (优先通信方法)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)

23
documents/src/json/de.json
View file

@ -52,6 +52,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "Wie kann ich autoren zusammenbringen?" "h3": "Wie kann ich autoren zusammenbringen?"
}, },

23
documents/src/json/en.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "How to concat authors?" "h3": "How to concat authors?"
}, },

23
documents/src/json/es.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "Cómo combinar a los autores?" "h3": "Cómo combinar a los autores?"
}, },

23
documents/src/json/fr.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "Comment pouvez-vous combiner les auteurs ?" "h3": "Comment pouvez-vous combiner les auteurs ?"
}, },

23
documents/src/json/ja.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "作者をまとめるにはどうすればいいですか？" "h3": "作者をまとめるにはどうすればいいですか？"
}, },

23
documents/src/json/pt.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "Como combinar os autores?" "h3": "Como combinar os autores?"
}, },

25
documents/src/json/ru.json
View file

@ -52,6 +52,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "Как создать отчёт?"
},
{
"p": "Если у вас установлен NodeJS, то вы можете выполнить:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "Скрипт создаст папку `./assayo` с отчётом по данному репозиторию:"
},
{
"pre": [
"./assayo/index.html - отчёт",
"./assayo/log.txt - информация полученная из git log"
]
},
{
"p": "Если NodeJS у вас не установлен, тогда см. пункты «Как выгрузить данные из git?» и «Как посмотреть отчёт?»"
},
{ {
"h3": "Как объединить авторов?" "h3": "Как объединить авторов?"
}, },
@ -110,7 +133,7 @@
"p": "Или откройте сохраненный файл и вручную измените кодировку на UTF-8." "p": "Или откройте сохраненный файл и вручную измените кодировку на UTF-8."
}, },
{ {
"h3": "Как посмотреть отчёт? " "h3": "Как посмотреть отчёт?"
}, },
{ {
"h4": "Онлайн" "h4": "Онлайн"

23
documents/src/json/zh.json
View file

@ -55,6 +55,29 @@
"git shortlog -s -n -e" "git shortlog -s -n -e"
] ]
}, },
{
"h3": "How to create a report?"
},
{
"p": "If you have NodeJS, you can run:"
},
{
"pre": [
"npx assayo"
]
},
{
"p": "The script will create a folder `./assayo` with a report about repository:"
},
{
"pre": [
"./assayo/index.html - report",
"./assayo/log.txt - information from git"
]
},
{
"p": "If you do not have NodeJS , see the items \"How to download data from git?\" and \"How to view the report?\""
},
{ {
"h3": "如何 combine 作者？" "h3": "如何 combine 作者？"
}, },

1
documents/src/lib/JsonToMd/TableOfContent.js
View file

@ -4,6 +4,7 @@ const SMILES = [
'👑', // 3 '👑', // 3
null, // 4 null, // 4
'🚀', // 5 '🚀', // 5
'🚀', // 5
'‍🎭', // 6 '‍🎭', // 6
'📤', // 7 '📤', // 7
null, // 8 null, // 8