dmitriy.kazimirov/assayo
1
0
Fork 0
mirror of https://github.com/bakhirev/assayo.git synced 2025-09-01 18:19:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update

Browse source
This commit is contained in:
bakhirev 2025-07-05 19:53:26 +03:00
parent 6077018c0a
commit 151a485f74
11 changed files with 294 additions and 347 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

198
README.md
View file

@ -24,64 +24,48 @@ Creates an HTML-report with analysis of commit statistics. A tool for team leade
- places for refactoring, deleted files, etc.
<a name="link-1"></a>
##### Team lead can evaluate employees
- identify slackers;
- estimate the amount of code;
- learn the work speed;
- notice behavioral anomalies;
- see the dynamics of work by week;
<a name="link-2"></a>
##### 🚀 Founder can evaluate product
- product cost;
- cost of features;
- development time;
- forecast of rework time;
- forecast cost;
<a name="link-3"></a>
### ‍🎭 Table of contents
- [How to quickly view the number of commits?](#link-4)
- [How to concat authors?](#link-5)
- [How to export data from git?](#link-6)
- [For online viewing](#link-7)
- [For offline viewing](#link-8)
- [If you use PowerShell in Windows](#link-9)
- [How to create and view the report?](#link-10)
- [Using website](#link-11)
- [Use the library NodeJS](#link-12)
- [Use the library PHP](#link-13)
- [Use the library Python](#link-14)
- [Use the library Ruby](#link-15)
- [Use the library Go](#link-16)
- [Use source code](#link-17)
- [How to rebuild the HTML report from source code?](#link-18)
- [How to view a report on a group of microservices?](#link-19)
- [How to brand the interface?](#link-20)
- [How to sign commits?](#link-21)
- [How to add checking for commit message?](#link-22)
- [Use file commit-msg](#link-23)
- [Use package pre-commit](#link-24)
- [How to automate data collection?](#link-25)
- [With backend](#link-26)
- [Without backend](#link-27)
- [DevOps ](#link-28)
- [Github Actions](#link-29)
- [Public server](#link-30)
- [Private server](#link-31)
- [️ About application](#link-32)
- [Architecture](#link-33)
- [How to add or edit a translation?](#link-34)
- [RoadMap:](#link-35)
- [Feedback, comments](#link-36)
<a name="link-4"></a>
### 📤 How to quickly view the number of commits?
### Table of contents
- [Table of contents](#link-1)
- [How to quickly view the number of commits?](#link-2)
- [How to export data from git?](#link-4)
- [For online viewing](#link-5)
- [For offline viewing](#link-6)
- [If you use PowerShell in Windows](#link-7)
- [How to create and view the report?](#link-8)
- [Using website](#link-9)
- [Use the library NodeJS](#link-10)
- [Use the library PHP](#link-11)
- [Use the library Python](#link-12)
- [Use the library Ruby](#link-13)
- [Use the library Go](#link-14)
- [Use source code](#link-15)
- [How to rebuild the HTML report from source code?](#link-16)
- [How to view a report on a group of microservices?](#link-17)
- [How to brand the interface?](#link-18)
- [How to sign commits?](#link-19)
- [How to add checking for commit message?](#link-20)
- [Use file commit-msg](#link-21)
- [Use package pre-commit](#link-22)
- [How to automate data collection?](#link-23)
- [With backend](#link-24)
- [Without backend](#link-25)
- [DevOps ](#link-26)
- [Github Actions](#link-27)
- [Public server](#link-28)
- [Private server](#link-29)
- [️ About application](#link-30)
- [Architecture](#link-31)
- [How to add or edit a translation?](#link-32)
- [RoadMap:](#link-33)
- [Feedback, comments](#link-34)
<a name="link-2"></a>
### 🚀 How to quickly view the number of commits?
In the root directory of your project, run:
```
git shortlog -s -n -e
```
<a name="link-5"></a>
### How to concat authors?
<a name="link-3"></a>
### ‍🎭 How to concat authors?
In the root directory of your project, you need to create a `.mailmap` file.
Example of the contents of the file:
```
@ -91,88 +75,88 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
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).
<a name="link-6"></a>
### How to export data from git?
<a name="link-7"></a>
<a name="link-4"></a>
### 📤 How to export data from git?
<a name="link-5"></a>
#### For online viewing
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
```
<a name="link-8"></a>
#### 📈 For offline viewing
<a name="link-6"></a>
#### 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/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > 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 `
<a name="link-9"></a>
<a name="link-7"></a>
#### If you use PowerShell in Windows
By default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command.
```
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
```
Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### How to create and view the report?
<a name="link-11"></a>
<a name="link-8"></a>
### 📈 How to create and view the report?
<a name="link-9"></a>
#### Using website
- go to the [website](https://bakhirev.github.io/);
- click the “[Demo](https://bakhirev.github.io/demo)” button;
- drop the `log.txt` file into the browser window;
<a name="link-12"></a>
<a name="link-10"></a>
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
<a name="link-13"></a>
<a name="link-11"></a>
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
<a name="link-14"></a>
<a name="link-12"></a>
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use the library Ruby
<a name="link-13"></a>
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-16"></a>
#### 🗃️ Use the library Go
<a name="link-14"></a>
#### Use the library Go
- run `go get github.com/bakhirev/assayo`
- run `go install github.com/bakhirev/assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-17"></a>
#### 🎨 Use source code
<a name="link-15"></a>
#### Use source code
- download this repository `git clone https://github.com/bakhirev/assayo.git`;
- drop the `log.txt` file to the `/build` folder;
- 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`.
In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
<a name="link-18"></a>
### 📝 How to rebuild the HTML report from source code?
<a name="link-16"></a>
### 🏭 How to rebuild the HTML report from source code?
- download this repository `git clone https://github.com/bakhirev/assayo.git`
- run `npm install`
- run `npm run build:local`
- the new HTML build will be in the `/build` folder
<a name="link-19"></a>
### 👮 How to view a report on a group of microservices?
<a name="link-17"></a>
### 🗃️ 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;
- 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`).
<a name="link-20"></a>
### How to brand the interface?
<a name="link-18"></a>
### 🎨 How to brand the interface?
You can create your own interface theme. Options:
- **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.
@ -180,8 +164,8 @@ You can create your own interface theme. Options:
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-21"></a>
### How to sign commits?
<a name="link-19"></a>
### 📝 How to sign commits?
Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:
```
JIRA-1234 feat(profile): Added avatar for user
@ -191,9 +175,9 @@ JIRA-1234 feat(profile): Added avatar for user
- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
- what problem were solved `(Added avatar for user)`
<a name="link-22"></a>
### 📚 How to add checking for commit message?
<a name="link-23"></a>
<a name="link-20"></a>
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file:
@ -204,7 +188,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1
fi
```
<a name="link-24"></a>
<a name="link-22"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`:
```
@ -216,13 +200,13 @@ fi
...
```
2. Run command `npm install pre-commit`
<a name="link-25"></a>
### 🛠️ How to automate data collection?
<a name="link-26"></a>
<a name="link-23"></a>
### 📚 How to automate data collection?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-27"></a>
<a name="link-25"></a>
#### Without backend
- create a clone of the repository you need;
- copy the `build` folder to the root;
@ -230,19 +214,19 @@ fi
- 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.
<a name="link-28"></a>
### DevOps (CI/CD)
<a name="link-29"></a>
#### 🛠️ Github Actions
<a name="link-26"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
<a name="link-30"></a>
#### 📐 Public server
<a name="link-28"></a>
#### Public server
You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it.
```
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-31"></a>
#### 🈯 Private server
<a name="link-29"></a>
#### Private server
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
- run it on your local network;
- use the web interface to view the reports, set the URL of the data in the URL parameter ```dump```:
@ -253,21 +237,21 @@ assayo_url - URL of the assayo container, it listens on port 80;
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.
<a name="link-32"></a>
### 🗺️ ️ About application
<a name="link-33"></a>
#### 📧 Architecture
<a name="link-30"></a>
### 🛠️ ️ About application
<a name="link-31"></a>
#### 📐 Architecture
<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.
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.
<a name="link-34"></a>
#### How to add or edit a translation?
<a name="link-32"></a>
#### 🈯 How to add or edit a translation?
You can add a new translation or correct an existing one in the ```ts/translations/``` folder.
[Instruction](https://github.com/firstcontributions/first-contributions)
<a name="link-35"></a>
#### RoadMap:
<a name="link-33"></a>
#### 🗺️ RoadMap:
Releases are planned approximately once every six months. What’s next:
- more recommendations and achievements;
- annual/monthly summaries, report printing;
@ -276,8 +260,10 @@ Releases are planned approximately once every six months. What’s next:
- different roles for statistics (hiding finances);
- development of the backend, integration with other systems;
<a name="link-36"></a>
#### Feedback, comments
<a name="link-34"></a>
#### 📧 Feedback, comments
- 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication)
- 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=en)

32
documents/DE.md
View file

@ -134,7 +134,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- laden sie dieses repository herunter
- datei ziehen `log.txt` in den ordner`/build`
- starten `/build/index.html`
@ -142,20 +142,20 @@ Or open a saved file and manually change the encoding to UTF-8.
Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstellt wird.
<a name="link-16"></a>
### 🗃️ Wie kann ich die berichtsdatei neu erstellen?
### 🏭 Wie kann ich die berichtsdatei neu erstellen?
- Laden sie dieses repository herunter
- Erfüllen `npm install`
- Erfüllen `npm run build:local`
- Der neue build wird im ordner sein `/build`
<a name="link-17"></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.)
- 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`).
<a name="link-18"></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:
- **Ü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.
@ -164,7 +164,7 @@ Sie können ihr skin für die schnittstelle schreiben. Kann geändert werden:
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></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:
```
JIRA-1234 feat(profile): added avatar for user
@ -175,7 +175,7 @@ JIRA-1234 feat(profile): added avatar for user
- beschreibung der arbeit `(added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -188,7 +188,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -200,13 +200,13 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### Wie kann ich die datenerfassung automatisieren?
### 📚 Wie kann ich die datenerfassung automatisieren?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ Kein bekend
#### Kein bekend
- erstellen sie einen klon ihres repositorys;
- kopieren sie den ordner `build` aus dem aktuellen repository;
- öffnen `build/index.html` im browser und zu lesezeichen hinzufügen;
@ -214,7 +214,7 @@ fi
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-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -225,7 +225,7 @@ Sie können eine datendatei zum erstellen eines berichts auf eine öffentliche U
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ Privater server
#### Privater server
- herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo);
- führen Sie es im lokalen netzwerk aus;
- um berichte anzuzeigen, verwenden sie die webschnittstelle, um die adresse anzugeben, an der sich die daten befinden, im URL-parameter ```dump```:
@ -237,23 +237,23 @@ 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.
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></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)
<a name="link-33"></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/```.
[Anleitung](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### Wünsche, Anregungen, Kommentare
#### 📧 Wünsche, Anregungen, Kommentare
- telegramm [@bakhirev](https://t.me/bakhirev) (vorrangiger kommunikationsweg)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- web site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=de)

194
documents/EN.md
View file

@ -24,64 +24,48 @@ Creates an HTML-report with analysis of commit statistics. A tool for team leade
- places for refactoring, deleted files, etc.
<a name="link-1"></a>
##### Team lead can evaluate employees
- identify slackers;
- estimate the amount of code;
- learn the work speed;
- notice behavioral anomalies;
- see the dynamics of work by week;
### Table of contents
- [Table of contents](#link-1)
- [How to quickly view the number of commits?](#link-2)
- [How to export data from git?](#link-4)
- [For online viewing](#link-5)
- [For offline viewing](#link-6)
- [If you use PowerShell in Windows](#link-7)
- [How to create and view the report?](#link-8)
- [Using website](#link-9)
- [Use the library NodeJS](#link-10)
- [Use the library PHP](#link-11)
- [Use the library Python](#link-12)
- [Use the library Ruby](#link-13)
- [Use the library Go](#link-14)
- [Use source code](#link-15)
- [How to rebuild the HTML report from source code?](#link-16)
- [How to view a report on a group of microservices?](#link-17)
- [How to brand the interface?](#link-18)
- [How to sign commits?](#link-19)
- [How to add checking for commit message?](#link-20)
- [Use file commit-msg](#link-21)
- [Use package pre-commit](#link-22)
- [How to automate data collection?](#link-23)
- [With backend](#link-24)
- [Without backend](#link-25)
- [DevOps ](#link-26)
- [Github Actions](#link-27)
- [Public server](#link-28)
- [Private server](#link-29)
- [️ About application](#link-30)
- [Architecture](#link-31)
- [How to add or edit a translation?](#link-32)
- [RoadMap:](#link-33)
- [Feedback, comments](#link-34)
<a name="link-2"></a>
##### 🚀 Founder can evaluate product
- product cost;
- cost of features;
- development time;
- forecast of rework time;
- forecast cost;
<a name="link-3"></a>
### ‍🎭 Table of contents
- [How to quickly view the number of commits?](#link-4)
- [How to concat authors?](#link-5)
- [How to export data from git?](#link-6)
- [For online viewing](#link-7)
- [For offline viewing](#link-8)
- [If you use PowerShell in Windows](#link-9)
- [How to create and view the report?](#link-10)
- [Using website](#link-11)
- [Use the library NodeJS](#link-12)
- [Use the library PHP](#link-13)
- [Use the library Python](#link-14)
- [Use the library Ruby](#link-15)
- [Use the library Go](#link-16)
- [Use source code](#link-17)
- [How to rebuild the HTML report from source code?](#link-18)
- [How to view a report on a group of microservices?](#link-19)
- [How to brand the interface?](#link-20)
- [How to sign commits?](#link-21)
- [How to add checking for commit message?](#link-22)
- [Use file commit-msg](#link-23)
- [Use package pre-commit](#link-24)
- [How to automate data collection?](#link-25)
- [With backend](#link-26)
- [Without backend](#link-27)
- [DevOps ](#link-28)
- [Github Actions](#link-29)
- [Public server](#link-30)
- [Private server](#link-31)
- [️ About application](#link-32)
- [Architecture](#link-33)
- [How to add or edit a translation?](#link-34)
- [RoadMap:](#link-35)
- [Feedback, comments](#link-36)
<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:
```
git shortlog -s -n -e
```
<a name="link-5"></a>
### How to concat authors?
<a name="link-3"></a>
### ‍🎭 How to concat authors?
In the root directory of your project, you need to create a `.mailmap` file.
Example of the contents of the file:
```
@ -91,88 +75,88 @@ Alex B <alex@mail.uk> <bakhirev@ya.kz>
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).
<a name="link-6"></a>
### How to export data from git?
<a name="link-7"></a>
<a name="link-4"></a>
### 📤 How to export data from git?
<a name="link-5"></a>
#### For online viewing
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
```
<a name="link-8"></a>
#### 📈 For offline viewing
<a name="link-6"></a>
#### 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/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > 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 `
<a name="link-9"></a>
<a name="link-7"></a>
#### If you use PowerShell in Windows
By default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command.
```
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
```
Or open a saved file and manually change the encoding to UTF-8.
<a name="link-10"></a>
### How to create and view the report?
<a name="link-11"></a>
<a name="link-8"></a>
### 📈 How to create and view the report?
<a name="link-9"></a>
#### Using website
- go to the [website](https://bakhirev.github.io/);
- click the “[Demo](https://bakhirev.github.io/demo)” button;
- drop the `log.txt` file into the browser window;
<a name="link-12"></a>
<a name="link-10"></a>
#### Use the library NodeJS
- run `npx assayo`
- open `./assayo/index.html`
<a name="link-13"></a>
<a name="link-11"></a>
#### Use the library PHP
- run `composer require bakhirev/assayo`
- run `vendor/bin/assayo`
- open `./assayo/index.html`
<a name="link-14"></a>
<a name="link-12"></a>
#### Use the library Python
- run `pipx install assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use the library Ruby
<a name="link-13"></a>
#### Use the library Ruby
- run `gem install assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-16"></a>
#### 🗃️ Use the library Go
<a name="link-14"></a>
#### Use the library Go
- run `go get github.com/bakhirev/assayo`
- run `go install github.com/bakhirev/assayo`
- run `assayo`
- open `./assayo/index.html`
<a name="link-17"></a>
#### 🎨 Use source code
<a name="link-15"></a>
#### Use source code
- download this repository `git clone https://github.com/bakhirev/assayo.git`;
- drop the `log.txt` file to the `/build` folder;
- 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`.
In this case, it is important that the `log.txt` file is generated by the command for offline viewing.
<a name="link-18"></a>
### 📝 How to rebuild the HTML report from source code?
<a name="link-16"></a>
### 🏭 How to rebuild the HTML report from source code?
- download this repository `git clone https://github.com/bakhirev/assayo.git`
- run `npm install`
- run `npm run build:local`
- the new HTML build will be in the `/build` folder
<a name="link-19"></a>
### 👮 How to view a report on a group of microservices?
<a name="link-17"></a>
### 🗃️ 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;
- 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`).
<a name="link-20"></a>
### How to brand the interface?
<a name="link-18"></a>
### 🎨 How to brand the interface?
You can create your own interface theme. Options:
- **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.
@ -180,8 +164,8 @@ You can create your own interface theme. Options:
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-21"></a>
### How to sign commits?
<a name="link-19"></a>
### 📝 How to sign commits?
Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:
```
JIRA-1234 feat(profile): Added avatar for user
@ -191,9 +175,9 @@ JIRA-1234 feat(profile): Added avatar for user
- feature `(profile - new page on site or new function, use one (two) short word or an abbreviation)`
- what problem were solved `(Added avatar for user)`
<a name="link-22"></a>
### 📚 How to add checking for commit message?
<a name="link-23"></a>
<a name="link-20"></a>
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
2. Add this text in file:
@ -204,7 +188,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
exit 1
fi
```
<a name="link-24"></a>
<a name="link-22"></a>
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Add in file `package.json` property `commit-msg`:
```
@ -216,13 +200,13 @@ fi
...
```
2. Run command `npm install pre-commit`
<a name="link-25"></a>
### 🛠️ How to automate data collection?
<a name="link-26"></a>
<a name="link-23"></a>
### 📚 How to automate data collection?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-27"></a>
<a name="link-25"></a>
#### Without backend
- create a clone of the repository you need;
- copy the `build` folder to the root;
@ -230,19 +214,19 @@ fi
- 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.
<a name="link-28"></a>
### DevOps (CI/CD)
<a name="link-29"></a>
#### 🛠️ Github Actions
<a name="link-26"></a>
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
<a name="link-30"></a>
#### 📐 Public server
<a name="link-28"></a>
#### Public server
You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it.
```
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-31"></a>
#### 🈯 Private server
<a name="link-29"></a>
#### Private server
- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);
- run it on your local network;
- use the web interface to view the reports, set the URL of the data in the URL parameter ```dump```:
@ -253,21 +237,21 @@ assayo_url - URL of the assayo container, it listens on port 80;
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.
<a name="link-32"></a>
### 🗺️ ️ About application
<a name="link-33"></a>
#### 📧 Architecture
<a name="link-30"></a>
### 🛠️ ️ About application
<a name="link-31"></a>
#### 📐 Architecture
<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.
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.
<a name="link-34"></a>
#### How to add or edit a translation?
<a name="link-32"></a>
#### 🈯 How to add or edit a translation?
You can add a new translation or correct an existing one in the ```ts/translations/``` folder.
[Instruction](https://github.com/firstcontributions/first-contributions)
<a name="link-35"></a>
#### RoadMap:
<a name="link-33"></a>
#### 🗺️ RoadMap:
Releases are planned approximately once every six months. What’s next:
- more recommendations and achievements;
- annual/monthly summaries, report printing;
@ -276,8 +260,8 @@ Releases are planned approximately once every six months. What’s next:
- different roles for statistics (hiding finances);
- development of the backend, integration with other systems;
<a name="link-36"></a>
#### Feedback, comments
<a name="link-34"></a>
#### 📧 Feedback, comments
- 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication)
- 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=en)

32
documents/ES.md
View file

@ -135,7 +135,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- descargar este repositorio
- arrastrar y soltar archivo `log.txt` en la carpeta `/build`
- lanzar `/build/index.html`
@ -143,20 +143,20 @@ Or open a saved file and manually change the encoding to UTF-8.
En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión.
<a name="link-16"></a>
### 🗃️ Como recompilar el build de un informe?
### 🏭 Como recompilar el build de un informe?
- Descargar este repositorio
- Ejecutar `npm install`
- Ejecutar `npm run build:local`
- La nueva compilación estará en el directorio `/build`
<a name="link-17"></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.)
- 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`).
<a name="link-18"></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:
- **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.
@ -165,7 +165,7 @@ Puedes crear tu propio tema para la interfaz. Puedes cambiar:
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></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:
```
JIRA-1234 feat(profile): Added avatar for user
@ -176,7 +176,7 @@ JIRA-1234 feat(profile): Added avatar for user
- ¿qué problema resolvieron? `(Added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -189,7 +189,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -201,13 +201,13 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### ¿Cómo automatizar el recolección de datos?
### 📚 ¿Cómo automatizar el recolección de datos?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ Sin backend
#### Sin backend
- clone del repositorio que desea;
- copiar a la carpeta raíz `build`;
- abridlo `build/index.html` añadir a favoritos;
@ -216,7 +216,7 @@ fi
(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.
<a name="link-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -227,7 +227,7 @@ Puede publicar el archivo con los datos para generar el informe en una URL públ
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ Servidor privado
#### Servidor privado
- descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- recogerlo en la red local;
- Para ver los informes, use la interfaz web indicándole la dirección de los datos en el parámetro URL ```dump```:
@ -239,16 +239,16 @@ 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
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></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;
- resultados del año / mes, impresión de informes;
- localización e internacionalización;
@ -257,11 +257,11 @@ Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.
- desarrollo de la parte de atrás, integraciones con otros sistemas;
<a name="link-33"></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/```.
[Instrucciones](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### Deseos, comentarios
#### 📧 Deseos, comentarios
- telegramm [@bakhirev](https://t.me/bakhirev) (La forma preferencial de contacto)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- sitio web [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=es)

32
documents/FR.md
View file

@ -135,27 +135,27 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- Télécharger ce dépôt
- Glisser le fichier `log.txt` dans le dossier `/build`
- Démarrer `/build/index.html`
- Ou coller le dossier `/build` Sur votre dépôt (là où se trouve `log.txt`). Vous pouvez changer le nom. Par exemple avec `/build` sur `/report`. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne.
<a name="link-16"></a>
### 🗃️ Comment recompiler la build du rapport?
### 🏭 Comment recompiler la build du rapport?
- Télécharger ce dépôt
- Exécuter `npm install`
- Exécuter `npm run build:local`
- La dernière build sera dans le dossier `/build`
<a name="link-17"></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.)
- 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`).
<a name="link-18"></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 :
- **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.
@ -164,7 +164,7 @@ Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></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:
```
JIRA-1234 feat(profile): Added avatar for user
@ -175,7 +175,7 @@ JIRA-1234 feat(profile): Added avatar for user
- quel problème ont-ils résolu `(Added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -188,7 +188,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -200,20 +200,20 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### Comment automatiser la collecte de données?
### 📚 Comment automatiser la collecte de données?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ Sans back-end
#### Sans back-end
- clonez le dépôt que vous voulez ;
- copiez le dossier `build`;
- Ouvrez `build/index.html` dans le navigateur et ajoutez-le aux favoris;
- ajoutez un raccourci sur `build/assets/ci-cd.sh` dans le dossier de démarrage automatique (Windows); Chaque fois que votre ordinateur se recharge, le script mettra à jour les statistiques sur toutes les données qui se sont automatiquement insérées dans la branche principale.
<a name="link-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -224,7 +224,7 @@ Vous pouvez mettre à disposition le fichier avec les données pour construire l
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ Serveur privé
#### Serveur privé
- télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- Soulevez-le sur le réseau local;
- Pour consulter les rapports, utilisez l’interface web en lui indiquant l’adresse où les données se trouvent, sous forme de paramètre dans l’URL ```dump```:
@ -236,16 +236,16 @@ 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.
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></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;
- résultats de l’année / du mois, impression des rapports;
- localisation et internationalisation;
@ -254,11 +254,11 @@ Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne foncti
- développement du backend, intégrations avec d’autres systèmes;
<a name="link-33"></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/```.
[Instruction](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### Souhaits, suggestions, commentaires
#### 📧 Souhaits, suggestions, commentaires
- telegramm [@bakhirev](https://t.me/bakhirev) (voie de communication prioritaire)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=fr)

32
documents/JA.md
View file

@ -135,7 +135,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- このリポジトリをダウンロードする
- ファイルをドラッグ＆ドロップする `log.txt` フォルダへ `/build`
- 実行するには `/build/index.html`
@ -143,20 +143,20 @@ Or open a saved file and manually change the encoding to UTF-8.
重要なのは、ファイル `log.txt` インターネットが利用できない環境で、レポートを表示するために作成されたコマンドである必要があります。
<a name="link-16"></a>
### 🗃️ レポートファイルを再構成する方法は？
### 🏭 レポートファイルを再構成する方法は？
- このリポジトリをダウンロードしてください
- 実行するには `npm install`
- 実行するには `npm run build:local`
- 最新のビルドは、フォルダに含まれるでしょう `/build`
<a name="link-17"></a>
### 🎨 マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。
### 🗃️ マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。
- マイクロサービスごとにファイルを作成します。 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` など。)
- "インターネット上でレポートを見る方法"を参照してください。最後の手順では、すべてのファイルをブラウザのウィンドウに一度にドラッグ＆ドロップします。
- “インターネットなしでレポートを見る方法” を参照してください。第二段階では、マイクロサービスのすべてのファイルをドラッグしてドロップする必要があります。(`log-1.txt`, `log-2.txt`, `log-3.txt` など。) レポートフォルダへ (`/build`).
<a name="link-18"></a>
### 📝 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。
### 🎨 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。
インターフェースのテーマを独自に作成することができます。下記の項目は変更できます。
- **見出し**. それはURLパラメータで指定することができます ```title```. 例えば: ```?title=You Company```
- **CSS スタイル**. そのためにはCSSファイルを用意し、そのアドレスをURLパラメーターに指定する必要があります ```theme```. 例えば: ```?theme=//company.com/some.css```. クラス名をセレクターとして使用することができます。ほとんどの場合、新しいバージョンがリリースされると変更されません
@ -165,7 +165,7 @@ Or open a saved file and manually change the encoding to UTF-8.
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></a>
### 👮 commit文の署名方法は？
### 📝 commit文の署名方法は？
練習に従ってください [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例えば:
```
JIRA-1234 feat(profile): Added avatar for user
@ -176,7 +176,7 @@ JIRA-1234 feat(profile): Added avatar for user
- ジョブの説明 `(Added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -189,7 +189,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -201,13 +201,13 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### データの自動収集方法は？
### 📚 データの自動収集方法は？
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ バックエンドなし
#### バックエンドなし
- リポジトリのクローンを作成します。;
- フォルダをコピーする `build` 現在のリポジトリから;
- オープン `build/index.html` ブラウザでブックマークに追加します。;
@ -215,7 +215,7 @@ fi
コンピューターを再起動するとき、スクリプトはメインブランチに自動的に挿入されたすべてのデータについての統計を更新します。
<a name="link-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -226,7 +226,7 @@ Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExampl
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ プライベートサーバー
#### プライベートサーバー
- ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo);
- ローカルネットワーク内で実行します。;
- レポートの表示には、データが置かれている場所のアドレスがURLパラメータに入っていることを指定したウェブインターフェイスを使用します。 ```dump```:
@ -238,23 +238,23 @@ you_url - gitのログのコンテナーのURLアドレス;
```
デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></a>
#### 🗺️ 半年ごとにリリースを行います。次は何でしょうか。
#### 🈯 半年ごとにリリースを行います。次は何でしょうか。
見て！ [主なドキュメント](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-33"></a>
#### 📧 翻訳を追加または編集するにはどうすればいいでしょうか。
#### 🗺️ 翻訳を追加または編集するにはどうすればいいでしょうか。
新しい翻訳を追加するか、現在の翻訳を修正するために、以下のセクションでそれを行うことができます: ```ts/translations/```.
[取扱説明書](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### 願い、提案、コメント
#### 📧 願い、提案、コメント
- telegramm [@bakhirev](https://t.me/bakhirev) (優先通信方式)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- ウェブサイト [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=ja)

32
documents/PT.md
View file

@ -135,7 +135,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- Baixar este repositório
- Arraste o arquivo `log.txt` para a pasta `/build`
- Lançar `/build/index.html`
@ -143,20 +143,20 @@ Or open a saved file and manually change the encoding to UTF-8.
É importante que o arquivo `log.txt` foi criado por uma equipe para navegar sem internet.
<a name="link-16"></a>
### 🗃️ Como recompilar o arquivo do relatório?
### 🏭 Como recompilar o arquivo do relatório?
- Baixar este repositório
- Executar `npm install`
- Executar `npm run build:local`
- A compilação mais recente estará na pasta `/build`
<a name="link-17"></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.)
- 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`).
<a name="link-18"></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:
- **Cabeçalho**. Você pode especificar em um parâmetro da URL ```title```. Por exemplo: ```?title=You Company```
- **Themes**. 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.
@ -165,7 +165,7 @@ Você pode escrever seu próprio tema de interface. Pode mudar:
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></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:
```
JIRA-1234 feat(profile): Added avatar for user
@ -176,7 +176,7 @@ JIRA-1234 feat(profile): Added avatar for user
- descrição do trabalho `(Added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -189,7 +189,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -201,13 +201,13 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### Como automatizar a coleta de dados?
### 📚 Como automatizar a coleta de dados?
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ Sem backend
#### Sem backend
- criar um clone do seu repositório;
- copie a pasta `build` do repositório atual;
- abrir `build/index.html` no navegador e adicionar aos favoritos;
@ -215,7 +215,7 @@ fi
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-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -226,7 +226,7 @@ Você pode disponibilizar o arquivo com os dados para construção do relatório
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ Servidor Privado
#### Servidor Privado
- baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo);
- execute-o na rede local;
- Para visualizar os relatórios, utilize a interface web, indicando-lhe o endereço em que os dados se encontram localizados através do parâmetro URL ```dump```:
@ -238,23 +238,23 @@ 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.
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></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)
<a name="link-33"></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/```.
[Instrução](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></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)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- site [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=pt)

32
documents/RU.md
View file

@ -134,7 +134,7 @@ Git создаст файл `log.txt`. Он содержит данные для
- открыть `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Без установки библиотек
#### Без установки библиотек
- скачать этот репозиторий
- перетащить файл `log.txt` в папку `/build`
- запустить `/build/index.html`
@ -142,20 +142,20 @@ Git создаст файл `log.txt`. Он содержит данные для
В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра.
<a name="link-16"></a>
### 🗃️ Как пересобрать файл отчёта из исходного кода?
### 🏭 Как пересобрать файл отчёта из исходного кода?
- Скачать этот репозиторий
- Выполнить `npm install`
- Выполнить `npm run build:local`
- Свежая сборка будет в папке `/build`
<a name="link-17"></a>
### 🎨 Как посмотреть отчёт по группе микросервисов?
### 🗃️ Как посмотреть отчёт по группе микросервисов?
- Сгенерировать для каждого микросервиса файл `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`).
<a name="link-18"></a>
### 📝 Как брендировать интерфейс?
### 🎨 Как брендировать интерфейс?
Вы можете написать свою тему для интерфейса. Можно менять:
- **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company```
- **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий.
@ -164,7 +164,7 @@ Git создаст файл `log.txt`. Он содержит данные для
**Например:** [демо](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></a>
### 👮 Как подписывать коммиты?
### 📝 Как подписывать коммиты?
Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например:
```
JIRA-1234 feat(profile): Added avatar for user
@ -175,7 +175,7 @@ JIRA-1234 feat(profile): Added avatar for user
- какую проблему решали `(Added avatar for user)`
<a name="link-20"></a>
### Как добавить проверку текста коммита?
### 👮 Как добавить проверку текста коммита?
<a name="link-21"></a>
#### Используя файл `commit-msg`
1. Создайте файл `commit-msg` в папке `.git/hooks/`
@ -188,7 +188,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></a>
#### 📚 Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit)
#### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit)
1. Добавьте в файл `package.json` блок `commit-msg`:
```
...
@ -200,13 +200,13 @@ fi
```
2. Выполните команду `npm install pre-commit`
<a name="link-23"></a>
### Как автоматизировать сбор данных?
### 📚 Как автоматизировать сбор данных?
<a name="link-24"></a>
#### С бекендом
- используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ Без бекенда
#### Без бекенда
- создайте клон нужного вам репозитория;
- скопируйте в корень папку `build`;
- откройте `build/index.html` в браузере и добавьте в закладки;
@ -214,7 +214,7 @@ fi
Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку.
<a name="link-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Добавьте [скрипт](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) в папку `.github/workflows/` или используйте этот [action](https://github.com/marketplace/actions/assayo) из официального магазина.
@ -225,7 +225,7 @@ fi
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ Приватный сервер
#### Приватный сервер
- скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo);
- поднимите его в локальной сети;
- для просмотра отчётов используйте веб-интерфейс указывая ему адресс, где лежат данные, в URL-параметре ```dump```:
@ -237,16 +237,16 @@ you_url - URL адресс вашего контейнера с логами
```
По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт.
<a name="link-30"></a>
### 📐 ️ О приложении
### 🛠️ ️ О приложении
<a name="link-31"></a>
#### 🈯 Архитектура
#### 📐 Архитектура
<img src="https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg" width="70%" />
1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) отображение списка отчётов. Каждый отчёт имеет название, описание и список репозиториев.
2. [Crawler service](https://github.com/bakhirev/assayo-crawler) сборка, склейка, обработка логов из репозиториев для отчётов.
3. [Log visualization UI](https://github.com/bakhirev/assayo) **(вы тут)** отображение отчётов. Для работы ему нужен log файл с данными.
<a name="link-32"></a>
#### 🗺️ Релизы, примерно, раз в полгода. Что дальше:
#### 🈯 Релизы, примерно, раз в полгода. Что дальше:
- больше советов и достижений;
- итоги года / месяца, печать отчётов;
- локализация и интернационализация;
@ -255,11 +255,11 @@ you_url - URL адресс вашего контейнера с логами
- разработка бекенда, интеграции с другими системами;
<a name="link-33"></a>
#### 📧 Как добавить или отредактировать перевод?
#### 🗺️ Как добавить или отредактировать перевод?
Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```.
[Инструкция](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### Пожелания, предложения, замечания
#### 📧 Пожелания, предложения, замечания
- telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- сайт [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=ru)

32
documents/ZH.md
View file

@ -135,7 +135,7 @@ Or open a saved file and manually change the encoding to UTF-8.
- open `./assayo/index.html`
<a name="link-15"></a>
#### 🏭 Use source code
#### Use source code
- 下载这个存储库
- 拖放文件 `log.txt` 到文件夹 `/build`
- 要运行 `/build/index.html`
@ -143,20 +143,20 @@ Or open a saved file and manually change the encoding to UTF-8.
重要的事情是，必须让log.txt这个文件是通过命令创建出来的，这样它就可以在没有网的时候查看了。
<a name="link-16"></a>
### 🗃️ 如何重打包报告文件？
### 🏭 如何重打包报告文件？
- 下载这个储存库
- 要执行 `npm install`
- 要执行 `npm run build:local`
- 最新的构建将在文件夹 `/build`
<a name="link-17"></a>
### 🎨 如何查看微服务组的报告？
### 🗃️ 如何查看微服务组的报告？
- 为每个微服务生成文件 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等)
- 参见“如何在有网络环境下查看报告”。在最后一步，将所有文件同时拖入浏览器窗口。
- 参见“如何在没有网络环境下查看报告”。第二步将所有微服务文件拖动到 (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) 到报表文件夹 (`/build`).
<a name="link-18"></a>
### 📝 如何将界面重新配色为公司专有颜色？
### 🎨 如何将界面重新配色为公司专有颜色？
您可以为界面创建自己的主题。可以修改：
- **标题**. 你可以在网址参数中指定它 ```title```. 例如: ```?title=You Company```
- **Themes**. 为了做到这一点，你需要准备一个CSS文件并在网址参数中指明其地址 ```theme```. 例如: ```?theme=//company.com/some.css```. 你可以使用类名作为选择器。大多数情况下，他们在新版本发布时不会发生变化。
@ -165,7 +165,7 @@ Or open a saved file and manually change the encoding to UTF-8.
**Example:** [demo](https://bakhirev.github.io/demo/themes/)
<a name="link-19"></a>
### 👮 如何签署提交？
### 📝 如何签署提交？
遵循实践 [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例如:
```
JIRA-1234 feat(profile): Added avatar for user
@ -176,7 +176,7 @@ JIRA-1234 feat(profile): Added avatar for user
- 职位描述 `(Added avatar for user)`
<a name="link-20"></a>
### How to add checking for commit message?
### 👮 How to add checking for commit message?
<a name="link-21"></a>
#### Use file `commit-msg`
1. Create file `commit-msg` in folder `.git/hooks/`
@ -189,7 +189,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((
fi
```
<a name="link-22"></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`:
```
...
@ -201,13 +201,13 @@ fi
```
2. Run command `npm install pre-commit`
<a name="link-23"></a>
### 如何自动化数据采集？
### 📚 如何自动化数据采集？
<a name="link-24"></a>
#### With backend
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
<a name="link-25"></a>
#### 🛠️ 没有后端
#### 没有后端
- 克隆您的仓库;
- 复制文件夹 `build` 从当前仓库;
- 打开 `build/index.html` 在浏览器中添加书签;
@ -215,7 +215,7 @@ fi
每次重启计算机，该脚本将更新统计数据，这些数据自动添加到主分支中。
<a name="link-26"></a>
### DevOps (CI/CD)
### 🛠️ DevOps (CI/CD)
<a name="link-27"></a>
#### Github Actions
Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) in folder `.github/workflows/` or use this [action](https://github.com/marketplace/actions/assayo) from the marketplace.
@ -226,7 +226,7 @@ Add [script](https://github.com/bakhirev/assayo/blob/main/documents/ActionExampl
https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt
```
<a name="link-29"></a>
#### 🛠️ 专用服务器
#### 专用服务器
- 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo);
- 在本地网络中运行它;
- 使用web界面查看报告，并指定数据所在地址作为URL参数 ```dump```:
@ -238,23 +238,23 @@ you_url - git日志的容器的URL地址;
```
默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用.
<a name="link-30"></a>
### 📐 ️ About application
### 🛠️ ️ About application
<a name="link-31"></a>
#### 🈯 Architecture
#### 📐 Architecture
<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.
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.
<a name="link-32"></a>
#### 🗺️ 释出版本大约每半年一次。接下来发生什么情况：
#### 🈯 释出版本大约每半年一次。接下来发生什么情况：
看 [主要文件](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
<a name="link-33"></a>
#### 📧 如何添加或编辑翻译？
#### 🗺️ 如何添加或编辑翻译？
您可以在“翻译”部分添加新翻译或更正当前翻译。 ```ts/translations/```.
[指示手册](https://github.com/firstcontributions/first-contributions)
<a name="link-34"></a>
#### 愿望，建议，意见
#### 📧 愿望，建议，意见
- telegramm [@bakhirev](https://t.me/bakhirev) (优先通信方法)
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
- 网站 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=zh)

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

@ -26,30 +26,6 @@
"places for refactoring, deleted files, etc."
]
},
{
"h5": "Team lead can evaluate employees"
},
{
"li": [
"identify slackers;",
"estimate the amount of code;",
"learn the work speed;",
"notice behavioral anomalies;",
"see the dynamics of work by week;"
]
},
{
"h5": "Founder can evaluate product"
},
{
"li": [
"product cost;",
"cost of features;",
"development time;",
"forecast of rework time;",
"forecast cost;"
]
},
{
"h3": "Table of contents"
},

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

@ -14,6 +14,7 @@ const SMILES = [
null, // 12
null, // 12
null, // 12
null, // 12
'🏭', // 13
'🗃️', // 14
'🎨', // 15