diff --git a/README.md b/README.md index 9f30aa2..02fb7df 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,7 @@ # [Assayo](https://assayo.online/?ref=github&lang=en) Visualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit - -**Links:** [demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt), [online version](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/763342/), [video](https://www.youtube.com/watch?v=mqfu-ea3jao). +Links: [demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt), [online version](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/763342/), [video](https://www.youtube.com/watch?v=mqfu-ea3jao). @@ -44,26 +43,28 @@ Visualization and analysis of git commit statistics. Performance tool for Team L - [Using website](#link-12) - [Use the library NodeJS](#link-13) - [Use the library PHP](#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) - - [Public server](#link-27) - - [Private server](#link-28) - - [How to update the Docker image?](#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) + - [Use the library Python](#link-15) + - [Use the library Ruby](#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) + - [Public server](#link-29) + - [Private server](#link-30) + - [How to update the Docker image?](#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) ### 🚀 How to quickly view the number of commits? In the root directory of your project, run: @@ -86,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -123,48 +129,58 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` [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. -### How to view the report? +### 📈 How to view the report? -#### 📈 Using website +#### Using website - go to the [website](https://assayo.online/); - click the “[Demo](https://assayo.online/demo?ref=github&lang=en)” button; - drop the `log.txt` file into the browser window; -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use 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. - + ### 🏭 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 - + ### 🗃️ 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`). - + ### 🎨 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. - **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es``` - + ### 📝 How to sign commits? Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example: ``` @@ -174,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - 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)` - what problem were solved `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -187,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -199,27 +215,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 How to automate data collection? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### Without backend - create a clone of the repository you need; - copy the `build` folder to the root; - 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); Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch. - + ### 🛠️ DevOps (CI/CD) - + #### 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. ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Private server - download the [docker image](https://hub.docker.com/r/bakhirev/assayo); - run it on your local network; @@ -230,27 +246,27 @@ 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. - + #### How to update the Docker image? - run ```npm run build:docker``` - run ```docker build -t assayo .``` - visually check the image ```docker run --name assayo -p 80:80 -d assayo```; - 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```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 How to add or edit a translation? You can add a new translation or correct an existing one in the ```ts/translations/``` folder. [Instruction](https://github.com/firstcontributions/first-contributions) - + #### 🗺️ RoadMap: Releases are planned approximately once every six months. What’s next: - more recommendations and achievements; @@ -259,8 +275,9 @@ Releases are planned approximately once every six months. What’s next: - file analysis; - different roles for statistics (hiding finances); - development of the backend, integration with other systems; - + #### 📧 Feedback, comments - Telegram Messenger [@bakhirev](https://t.me/bakhirev) (preferred method of communication) - 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - 🌐 [https://assayo.online/](https://assayo.online/?ref=github&lang=en) + diff --git a/documents/DE.md b/documents/DE.md index f0d9188..cba358e 100644 --- a/documents/DE.md +++ b/documents/DE.md @@ -40,28 +40,30 @@ Links: [demo](https://assayo.online/demo/?ref=github&lang=de&dump=./test.txt), [ - [If you use PowerShell in Windows](#link-10) - [Wie kann ich den bericht sehen?](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [Wie kann ich die berichtsdatei neu erstellen?](#link-16) -- [Wie kann ich den bericht zur microservices-gruppe anzeigen?](#link-17) -- [Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?](#link-18) -- [Wie signiere ich commits?](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [Wie kann ich die datenerfassung automatisieren?](#link-23) - - [With backend](#link-24) - - [Kein bekend](#link-25) -- [DevOps ](#link-26) - - [Öffentlicher server](#link-27) - - [Privater server](#link-28) - - [Aktualisieren eines Docker-Images](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-32) - - [Wie kann ich eine übersetzung hinzufügen oder bearbeiten?](#link-33) - - [Wünsche, Anregungen, Kommentare](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [Wie kann ich die berichtsdatei neu erstellen?](#link-18) +- [Wie kann ich den bericht zur microservices-gruppe anzeigen?](#link-19) +- [Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?](#link-20) +- [Wie signiere ich commits?](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [Wie kann ich die datenerfassung automatisieren?](#link-25) + - [With backend](#link-26) + - [Kein bekend](#link-27) +- [DevOps ](#link-28) + - [Öffentlicher server](#link-29) + - [Privater server](#link-30) + - [Aktualisieren eines Docker-Images](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-34) + - [Wie kann ich eine übersetzung hinzufügen oder bearbeiten?](#link-35) + - [Wünsche, Anregungen, Kommentare](#link-36) ### 🚀 Wie kann ich die anzahl der commits schnell sehen? In der wurzelverzeichnis ihres projektes muss der befehl ausgeführt werden: @@ -84,6 +86,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -123,46 +130,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### Wie kann ich den bericht sehen? +### 📈 Wie kann ich den bericht sehen? -#### 📈 Using website +#### Using website - gehe zu [Webseite](https://assayo.online/) - den knopf drücken “[Demonstration](https://assayo.online/demo?lang=ru)” - datei ziehen `log.txt` in das Browserfenster -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - laden sie dieses repository herunter - datei ziehen `log.txt` in den ordner`/build` - 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` Es ist wichtig, dass die log.txt datei vom befehl für die offlineansicht erstellt wird. - + ### 🏭 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` - + ### 🗃️ 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`). - + ### 🎨 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. - **Sprache**. Sie können es im URL-parameter angeben ```lang```. Zum Beispiel: ```?lang=es``` - + ### 📝 Wie signiere ich commits? Folge der praxis [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Zum beispiel: ``` @@ -172,9 +189,9 @@ JIRA-1234 feat(profile): added avatar for user - 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)` - beschreibung der arbeit `(added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -185,7 +202,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -197,27 +214,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 Wie kann ich die datenerfassung automatisieren? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### 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; - 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. - + ### 🛠️ DevOps (CI/CD) - + #### Ö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```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Privater server - herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo); - führen Sie es im lokalen netzwerk aus; @@ -228,30 +245,30 @@ assayo_url - die adresse des assayo-containers, er hört auf port 80; 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. - + #### Aktualisieren eines Docker-Images - befehl ausführen ```npm run build:docker``` - befehl ausführen ```docker build -t assayo .``` - ergebnis überprüfen ```docker run --name assayo -p 80:80 -d assayo```; - befehl ausführen ```docker tag assayo bakhirev/assayo:latest```; - senden sie ein containerimage an Docker Hub ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 Veröffentlichungen, ungefähr alle sechs monate. Was weiter: Schau [haupt dokumentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) - + #### 🗺️ 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) - + #### 📧 Wünsche, Anregungen, Kommentare - telegramm [@bakhirev](https://t.me/bakhirev) (vorrangiger kommunikationsweg) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/EN.md b/documents/EN.md index 240ce25..6473325 100644 --- a/documents/EN.md +++ b/documents/EN.md @@ -41,28 +41,30 @@ Links: [demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt), [ - [If you use PowerShell in Windows](#link-10) - [How to view the report?](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#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) - - [Public server](#link-27) - - [Private server](#link-28) - - [How to update the Docker image?](#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) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#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) + - [Public server](#link-29) + - [Private server](#link-30) + - [How to update the Docker image?](#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) ### 🚀 How to quickly view the number of commits? In the root directory of your project, run: @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,46 +131,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### How to view the report? +### 📈 How to view the report? -#### 📈 Using website +#### Using website - go to the [website](https://assayo.online/); - click the “[Demo](https://assayo.online/demo?ref=github&lang=en)” button; - drop the `log.txt` file into the browser window; -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use 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. - + ### 🏭 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 - + ### 🗃️ 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`). - + ### 🎨 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. - **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es``` - + ### 📝 How to sign commits? Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example: ``` @@ -173,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - 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)` - what problem were solved `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -186,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -198,27 +215,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 How to automate data collection? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### Without backend - create a clone of the repository you need; - copy the `build` folder to the root; - 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); Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch. - + ### 🛠️ DevOps (CI/CD) - + #### 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. ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Private server - download the [docker image](https://hub.docker.com/r/bakhirev/assayo); - run it on your local network; @@ -229,27 +246,27 @@ 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. - + #### How to update the Docker image? - run ```npm run build:docker``` - run ```docker build -t assayo .``` - visually check the image ```docker run --name assayo -p 80:80 -d assayo```; - 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```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 How to add or edit a translation? You can add a new translation or correct an existing one in the ```ts/translations/``` folder. [Instruction](https://github.com/firstcontributions/first-contributions) - + #### 🗺️ RoadMap: Releases are planned approximately once every six months. What’s next: - more recommendations and achievements; @@ -258,7 +275,7 @@ Releases are planned approximately once every six months. What’s next: - file analysis; - different roles for statistics (hiding finances); - development of the backend, integration with other systems; - + #### 📧 Feedback, comments - 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication) - 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/ES.md b/documents/ES.md index 48ec0bf..e26cefb 100644 --- a/documents/ES.md +++ b/documents/ES.md @@ -41,28 +41,30 @@ Links: [demo](https://assayo.online/demo/?ref=github&lang=es&dump=./test.txt), [ - [If you use PowerShell in Windows](#link-10) - [¿Cómo ver el informe?](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [Como recompilar el build de un informe?](#link-16) -- [Como mirar el reporte de un grupo de microservicios?](#link-17) -- [¿Cómo puedo personalizar la interfaz de usuario?](#link-18) -- [¿Cómo firmar los commits?](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [¿Cómo automatizar el recolección de datos?](#link-23) - - [With backend](#link-24) - - [Sin backend](#link-25) -- [DevOps ](#link-26) - - [Servidor público](#link-27) - - [Servidor privado](#link-28) - - [Actualización de la imagen Docker](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-32) - - [¿Cómo añadir o editar una traducción?](#link-33) - - [Deseos, comentarios](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [Como recompilar el build de un informe?](#link-18) +- [Como mirar el reporte de un grupo de microservicios?](#link-19) +- [¿Cómo puedo personalizar la interfaz de usuario?](#link-20) +- [¿Cómo firmar los commits?](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [¿Cómo automatizar el recolección de datos?](#link-25) + - [With backend](#link-26) + - [Sin backend](#link-27) +- [DevOps ](#link-28) + - [Servidor público](#link-29) + - [Servidor privado](#link-30) + - [Actualización de la imagen Docker](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-34) + - [¿Cómo añadir o editar una traducción?](#link-35) + - [Deseos, comentarios](#link-36) ### 🚀 Cómo puedo rápidamente ver el número de commits? En la carpeta raíz de su proyecto, ejecute: @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,46 +131,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### ¿Cómo ver el informe? +### 📈 ¿Cómo ver el informe? -#### 📈 Using website +#### Using website - ir a [sitio web](https://assayo.online/) - pulse el botón [Demo](https://assayo.online/demo?ref=github&lang=es)» - arrastrar y soltar archivo `log.txt` en la ventana del navegador -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - descargar este repositorio - arrastrar y soltar archivo `log.txt` en la carpeta `/build` - 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` En este caso, es importante que el archivo ' log.txt ' fue generado por el equipo para ver sin conexión. - + ### 🏭 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` - + ### 🗃️ 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`). - + ### 🎨 ¿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. - **La lengua**. Puedes especificarla en el parámetro de la URL ```lang```. Por ejemplo: ```?lang=es``` - + ### 📝 ¿Cómo firmar los commits? Siga la práctica [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Por ejemplo: ``` @@ -173,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - 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)` - ¿qué problema resolvieron? `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -186,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -198,12 +215,12 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 ¿Cómo automatizar el recolección de datos? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### Sin backend - clone del repositorio que desea; - copiar a la carpeta raíz `build`; @@ -211,15 +228,15 @@ fi - agregue un icono de `build/assets/ci-cd.sh` a su carpeta de inicio automático (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. - + ### 🛠️ DevOps (CI/CD) - + #### 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```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Servidor privado - descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo); - recogerlo en la red local; @@ -230,23 +247,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; ``` 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 - + #### Actualización de la imagen Docker - construir ```npm run build:docker``` - montar la imagen ```docker build -t 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 imagen en Docker Hub ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 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; @@ -254,11 +271,11 @@ Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0. - análisis de archivos; - diferentes roles para estadísticas (ocultación de finanzas); - desarrollo de la parte de atrás, integraciones con otros sistemas; - + #### 🗺️ ¿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) - + #### 📧 Deseos, comentarios - telegramm [@bakhirev](https://t.me/bakhirev) (La forma preferencial de contacto) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/FR.md b/documents/FR.md index 4cc218e..abb96f1 100644 --- a/documents/FR.md +++ b/documents/FR.md @@ -41,28 +41,30 @@ Links: [demo](https://assayo.online/demo/?ref=github&lang=fr&dump=./test.txt), [ - [If you use PowerShell in Windows](#link-10) - [Comment voir le rapport en ligne?](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [Comment recompiler la build du rapport?](#link-16) -- [Comment voir le compte rendu pour un groupe de microservices?](#link-17) -- [Comment apposer une marque sur l’interface?](#link-18) -- [Comment signer les commits ?](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [Comment automatiser la collecte de données?](#link-23) - - [With backend](#link-24) - - [Sans back-end](#link-25) -- [DevOps ](#link-26) - - [Serveur public](#link-27) - - [Serveur privé](#link-28) - - [Mise à jour de l’image-Docker](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-32) - - [Comment ajouter ou modifier une traduction?](#link-33) - - [Souhaits, suggestions, commentaires](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [Comment recompiler la build du rapport?](#link-18) +- [Comment voir le compte rendu pour un groupe de microservices?](#link-19) +- [Comment apposer une marque sur l’interface?](#link-20) +- [Comment signer les commits ?](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [Comment automatiser la collecte de données?](#link-25) + - [With backend](#link-26) + - [Sans back-end](#link-27) +- [DevOps ](#link-28) + - [Serveur public](#link-29) + - [Serveur privé](#link-30) + - [Mise à jour de l’image-Docker](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-34) + - [Comment ajouter ou modifier une traduction?](#link-35) + - [Souhaits, suggestions, commentaires](#link-36) ### 🚀 De combien de commits avez-vous besoin? Dans le répertoire racine de votre projet, exécutez les commandes suivantes: @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,45 +131,55 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### Comment voir le rapport en ligne? +### 📈 Comment voir le rapport en ligne? -#### 📈 Using website +#### Using website - Aller à [сайт](https://assayo.online/) - 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 -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - Télécharger ce dépôt - Glisser le fichier `log.txt` dans le dossier `/build` - Démarrer `/build/index.html` - Ou coller le dossier `/build` Sur votre dépôt (là où se trouve `log.txt`). Vous pouvez changer le nom. Par exemple avec `/build` sur `/report`. Dans cette cas, il est important que le fichier log.txt ait été généré par le commande pour la visualisation hors ligne. - + ### 🏭 Comment recompiler la build du rapport? - Télécharger ce dépôt - Exécuter `npm install` - Exécuter `npm run build:local` - La dernière build sera dans le dossier `/build` - + ### 🗃️ Comment voir le compte rendu pour un groupe de microservices? - générer un fichier pour chaque microservice `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` etc.) - 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`). - + ### 🎨 Comment apposer une marque sur l’interface? Vous pouvez écrire votre propre thème pour l’interface. Vous pouvez changer : - **En-tête**. Vous pouvez le spécifier dans le paramètre de l’URL ```title```. Par exemple: ```?title=You Company``` - **Thème visuel**.Pour cela, vous devez préparer un fichier CSS avec de nouveaux styles et indiquer son adresse dans le paramètre de l’URL ```theme```. Par exemple: ```?theme=//company.com/some.css```. Vous pouvez utiliser les noms de classes comme sélecteurs. La plupart d’entre elles ne changent pas lors de la sortie de nouvelles versions. - **Langue**. Vous pouvez l’indiquer dans le paramètre d’URL ```lang```. Par exemple: ```?lang=es``` - + ### 📝 Comment signer les commits ? Suivez la pratique [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Par exemple: ``` @@ -172,9 +189,9 @@ JIRA-1234 feat(profile): Added avatar for user - 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)` - quel problème ont-ils résolu `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -185,7 +202,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -197,26 +214,26 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 Comment automatiser la collecte de données? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### 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. - + ### 🛠️ DevOps (CI/CD) - + #### 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```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Serveur privé - télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo); - Soulevez-le sur le réseau local; @@ -227,23 +244,23 @@ assayo_url - URL Conteneur assayo, écoute le port 80; you_url - URL адресс Adresse de votre conteneur de logs git; ``` Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible. - + #### Mise à jour de l’image-Docker - constuire la build ```npm run build:docker``` - assembler l'image ```docker build -t assayo .``` - vérifier visuellement l'image ```docker run --name assayo -p 80:80 -d assayo```; - 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```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) displays a list of available reports. Each report consists of a title, description, and a list of repositories. 2. [Crawler service](https://github.com/bakhirev/assayo-crawler) collects repository logs for the report. 3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work. - + #### 🈯 Les versions sont publiées environ tous les six mois. Quoi de neuf: - plus de conseils et de succès; - résultats de l’année / du mois, impression des rapports; @@ -251,11 +268,11 @@ Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne foncti - analyse des fichiers; - différents rôles pour la statistique (cacher la finance); - développement du backend, intégrations avec d’autres systèmes; - + #### 🗺️ Comment ajouter ou modifier une traduction? Vous pouvez ajouter une nouvelle traduction ou corriger la traduction existante dans le section ```ts/translations/```. [Instruction](https://github.com/firstcontributions/first-contributions) - + #### 📧 Souhaits, suggestions, commentaires - telegramm [@bakhirev](https://t.me/bakhirev) (voie de communication prioritaire) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/JA.md b/documents/JA.md index 3d8f5af..5aea6fe 100644 --- a/documents/JA.md +++ b/documents/JA.md @@ -41,28 +41,30 @@ Links: [デモ](https://assayo.online/demo/?ref=github&lang=ja&dump=./test.txt), - [If you use PowerShell in Windows](#link-10) - [レポートを表示するにはどうすればよいですか？ ](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [レポートファイルを再構成する方法は？](#link-16) -- [マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。](#link-17) -- [自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。](#link-18) -- [commit文の署名方法は？](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [データの自動収集方法は？](#link-23) - - [With backend](#link-24) - - [バックエンドなし](#link-25) -- [DevOps ](#link-26) - - [公開サーバ](#link-27) - - [プライベートサーバー](#link-28) - - [Dockerイメージの更新](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [半年ごとにリリースを行います。次は何でしょうか。](#link-32) - - [翻訳を追加または編集するにはどうすればいいでしょうか。](#link-33) - - [願い、提案、コメント](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [レポートファイルを再構成する方法は？](#link-18) +- [マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。](#link-19) +- [自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。](#link-20) +- [commit文の署名方法は？](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [データの自動収集方法は？](#link-25) + - [With backend](#link-26) + - [バックエンドなし](#link-27) +- [DevOps ](#link-28) + - [公開サーバ](#link-29) + - [プライベートサーバー](#link-30) + - [Dockerイメージの更新](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [半年ごとにリリースを行います。次は何でしょうか。](#link-34) + - [翻訳を追加または編集するにはどうすればいいでしょうか。](#link-35) + - [願い、提案、コメント](#link-36) ### 🚀 コミット数を素早く確認するにはどうすればよいでしょうか。 プロジェクトのルートディレクトリで以下のコマンドを実行します: @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,46 +131,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### レポートを表示するにはどうすればよいですか？ +### 📈 レポートを表示するにはどうすればよいですか？ -#### 📈 Using website +#### Using website - に切り替える [ウェブサイト](https://assayo.online/) - ボタンを押す “[デモ](https://assayo.online/demo?lang=ru)” - ファイルをドラッグ＆ドロップする `log.txt` ブラウザウィンドウで -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - このリポジトリをダウンロードする - ファイルをドラッグ＆ドロップする `log.txt` フォルダへ `/build` - 実行するには `/build/index.html` - フォルダをドラッグして下さい `/build` 自分のリポジトリーにフォルダを置いてください (それがある場所 `log.txt`). 名前を変更することができます。例えば名前 `/build` を `/report` 重要なのは、ファイル `log.txt` インターネットが利用できない環境で、レポートを表示するために作成されたコマンドである必要があります。 - + ### 🏭 レポートファイルを再構成する方法は？ - このリポジトリをダウンロードしてください - 実行するには `npm install` - 実行するには `npm run build:local` - 最新のビルドは、フォルダに含まれるでしょう `/build` - + ### 🗃️ マイクロサービス群のレポートを表示するにはどうすればよいでしょうか。 - マイクロサービスごとにファイルを作成します。 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` など。) - "インターネット上でレポートを見る方法"を参照してください。最後の手順では、すべてのファイルをブラウザのウィンドウに一度にドラッグ＆ドロップします。 - “インターネットなしでレポートを見る方法” を参照してください。第二段階では、マイクロサービスのすべてのファイルをドラッグしてドロップする必要があります。(`log-1.txt`, `log-2.txt`, `log-3.txt` など。) レポートフォルダへ (`/build`). - + ### 🎨 自社のブランドカラーでインターフェースをリニュアルカラーに変えるにはどうすればよろしいでしょうか。 インターフェースのテーマを独自に作成することができます。下記の項目は変更できます。 - **見出し**. それはURLパラメータで指定することができます ```title```. 例えば: ```?title=You Company``` - **CSS スタイル**. そのためにはCSSファイルを用意し、そのアドレスをURLパラメーターに指定する必要があります ```theme```. 例えば: ```?theme=//company.com/some.css```. クラス名をセレクターとして使用することができます。ほとんどの場合、新しいバージョンがリリースされると変更されません - **言語**. URLパラメータに指定することができます ```lang```. 例えば: ```?lang=es``` - + ### 📝 commit文の署名方法は？ 練習に従ってください [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例えば: ``` @@ -173,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - 仕事の種類 `(feat, fix, style, refactor, test, doc など。)` - 仕事の分野 `(profile - サイトのセクション、ページ、新機能、簡単に)` - ジョブの説明 `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -186,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -198,27 +215,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 データの自動収集方法は？ - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### バックエンドなし - リポジトリのクローンを作成します。; - フォルダをコピーする `build` 現在のリポジトリから; - オープン `build/index.html` ブラウザでブックマークに追加します。; - にショートカットを追加する `build/assets/ci-cd.sh` 自動起動フォルダーに (Windows); コンピューターを再起動するとき、スクリプトはメインブランチに自動的に挿入されたすべてのデータについての統計を更新します。 - + ### 🛠️ DevOps (CI/CD) - + #### 公開サーバ データをレポートビルド用に公開するファイルをURLで公開することができます。その視覚化は、サイト上で利用可能なツールを使用することで行うことができます。 [assayo](https://assayo.online/). データがある場所のアドレスを、URLパラメータに入力してください。 ```dump```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### プライベートサーバー - ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo); - ローカルネットワーク内で実行します。; @@ -229,30 +246,30 @@ assayo_url - ポート80でリッスンしているassayoコンテナのURL; you_url - gitのログのコンテナーのURLアドレス; ``` デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。 - + #### Dockerイメージの更新 - 次のコマンドを実行します ```npm run build:docker``` - 次のコマンドを実行します ```docker build -t assayo .``` - 結果を確認する ```docker run --name assayo -p 80:80 -d assayo```; - 次のコマンドを実行します ```docker tag assayo bakhirev/assayo:latest```; - コンテナイメージをDocker Hubにアップロードする ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 半年ごとにリリースを行います。次は何でしょうか。 見て！ [主なドキュメント](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) - + #### 🗺️ 翻訳を追加または編集するにはどうすればいいでしょうか。 新しい翻訳を追加するか、現在の翻訳を修正するために、以下のセクションでそれを行うことができます: ```ts/translations/```. [取扱説明書](https://github.com/firstcontributions/first-contributions) - + #### 📧 願い、提案、コメント - telegramm [@bakhirev](https://t.me/bakhirev) (優先通信方式) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/PT.md b/documents/PT.md index 8db37ca..f272859 100644 --- a/documents/PT.md +++ b/documents/PT.md @@ -41,28 +41,30 @@ Links: [demo](https://assayo.online/demo/?ref=github&lang=pt&dump=./test.txt), [ - [If you use PowerShell in Windows](#link-10) - [Como ver o relatório?](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [Como recompilar o arquivo do relatório?](#link-16) -- [Como visualizar o relatório do grupo de microserviços?](#link-17) -- [Como alterar as cores da interface para as cores da sua marca?](#link-18) -- [Como faço para assinar commits?](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [Como automatizar a coleta de dados?](#link-23) - - [With backend](#link-24) - - [Sem backend](#link-25) -- [DevOps ](#link-26) - - [Servidor Público](#link-27) - - [Servidor Privado](#link-28) - - [Atualizar a imagem Docker](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:](#link-32) - - [Como adicionar ou editar uma tradução?](#link-33) - - [Sugestões, sugestões, comentários](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [Como recompilar o arquivo do relatório?](#link-18) +- [Como visualizar o relatório do grupo de microserviços?](#link-19) +- [Como alterar as cores da interface para as cores da sua marca?](#link-20) +- [Como faço para assinar commits?](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [Como automatizar a coleta de dados?](#link-25) + - [With backend](#link-26) + - [Sem backend](#link-27) +- [DevOps ](#link-28) + - [Servidor Público](#link-29) + - [Servidor Privado](#link-30) + - [Atualizar a imagem Docker](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:](#link-34) + - [Como adicionar ou editar uma tradução?](#link-35) + - [Sugestões, sugestões, comentários](#link-36) ### 🚀 Como é rápido ver o número de commits? No diretório raiz do seu projeto, execute o comando: @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,46 +131,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### Como ver o relatório? +### 📈 Como ver o relatório? -#### 📈 Using website +#### Using website - Ir para [site](https://assayo.online/) - Pressione o botão “[Demonstração](https://assayo.online/demo?lang=ru)” - Arrastar e largar `log.txt` na janela do navegador -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - Baixar este repositório - Arraste o arquivo `log.txt` para a pasta `/build` - 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` É importante que o arquivo `log.txt` foi criado por uma equipe para navegar sem internet. - + ### 🏭 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` - + ### 🗃️ 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`). - + ### 🎨 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``` - **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``` - + ### 📝 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: ``` @@ -173,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - tipo de trabalho `(feat, fix, style, refactor, test, doc etc.)` - área de trabalho `(profile - Página)` - descrição do trabalho `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -186,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -198,27 +215,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 Como automatizar a coleta de dados? - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### 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; - 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. - + ### 🛠️ DevOps (CI/CD) - + #### 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```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Servidor Privado - baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo); - execute-o na rede local; @@ -229,30 +246,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; ``` 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. - + #### Atualizar a imagem Docker - executar um comando ```npm run build:docker``` - executar um comando ```docker build -t assayo .``` - verificar o resultado ```docker run --name assayo -p 80:80 -d assayo```; - executar um comando ```docker tag assayo bakhirev/assayo:latest```; - enviar a imagem do container para o Docker Hub ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 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) - + #### 🗺️ 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) - + #### 📧 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) diff --git a/documents/RU.md b/documents/RU.md index a293276..6328e0d 100644 --- a/documents/RU.md +++ b/documents/RU.md @@ -32,7 +32,7 @@ ### Содержание - [Как быстро посмотреть количество коммитов?](#link-4) -- [Как создать отчёт?](#link-5) +- [Как создать отчёт с помощью библиотеки?](#link-5) - [Как объединить авторов?](#link-6) - [Как выгрузить данные из git?](#link-7) - [Для онлайн просмотра](#link-8) @@ -40,28 +40,30 @@ - [Если вы используете PowerShell в Windows](#link-10) - [Как посмотреть отчёт?](#link-11) - [Через сайт](#link-12) - - [Используя библиотеку ](#link-13) - - [Используя библиотеку ](#link-14) - - [Без установки библиотек](#link-15) -- [Как пересобрать файл отчёта из исходного кода?](#link-16) -- [Как посмотреть отчёт по группе микросервисов?](#link-17) -- [Как брендировать интерфейс?](#link-18) -- [Как подписывать коммиты?](#link-19) -- [Как добавить проверку текста коммита?](#link-20) - - [Используя файл commit-msg](#link-21) - - [Используя пакет pre-commit](#link-22) -- [Как автоматизировать сбор данных?](#link-23) - - [С бекендом](#link-24) - - [Без бекенда](#link-25) -- [DevOps ](#link-26) - - [Публичный сервер](#link-27) - - [Приватный сервер](#link-28) - - [Обновление Docker-образа](#link-29) -- [️ О приложении](#link-30) - - [Архитектура](#link-31) - - [Релизы, примерно, раз в полгода. Что дальше:](#link-32) - - [Как добавить или отредактировать перевод?](#link-33) - - [Пожелания, предложения, замечания](#link-34) + - [Используя библиотеку NodeJS](#link-13) + - [Используя библиотеку PHP](#link-14) + - [Используя библиотеку Python](#link-15) + - [Используя библиотеку Ruby](#link-16) + - [Без установки библиотек](#link-17) +- [Как пересобрать файл отчёта из исходного кода?](#link-18) +- [Как посмотреть отчёт по группе микросервисов?](#link-19) +- [Как брендировать интерфейс?](#link-20) +- [Как подписывать коммиты?](#link-21) +- [Как добавить проверку текста коммита?](#link-22) + - [Используя файл commit-msg](#link-23) + - [Используя пакет pre-commit](#link-24) +- [Как автоматизировать сбор данных?](#link-25) + - [С бекендом](#link-26) + - [Без бекенда](#link-27) +- [DevOps ](#link-28) + - [Публичный сервер](#link-29) + - [Приватный сервер](#link-30) + - [Обновление Docker-образа](#link-31) +- [️ О приложении](#link-32) + - [Архитектура](#link-33) + - [Релизы, примерно, раз в полгода. Что дальше:](#link-34) + - [Как добавить или отредактировать перевод?](#link-35) + - [Пожелания, предложения, замечания](#link-36) ### 🚀 Как быстро посмотреть количество коммитов? В корневой директории вашего проекта выполнить: @@ -69,11 +71,26 @@ git shortlog -s -n -e ``` -### 🏭 Как создать отчёт? -Если у вас установлен NodeJS, то вы можете выполнить: +### 🏭 Как создать отчёт с помощью библиотеки? +NodeJS: ``` npx assayo ``` +PHP: +``` +composer require bakhirev/assayo +vendor/bin/assayo +``` +Python: +``` +pipx install assayo +assayo +``` +Ruby: +``` +gem install assayo +assayo +``` Скрипт создаст папку `./assayo` с отчётом по данному репозиторию: ``` ./assayo/index.html - отчёт @@ -113,46 +130,56 @@ Git создаст файл `log.txt`. Он содержит данные для ``` Или откройте сохраненный файл и вручную измените кодировку на UTF-8. -### Как посмотреть отчёт? +### 📈 Как посмотреть отчёт? -#### 📈 Через сайт +#### Через сайт - Перейти на [сайт](https://assayo.online/) - Нажать кнопку «[Демо](https://assayo.online/demo?ref=github&lang=ru)» - Перетащить файл `log.txt` в окно браузера -#### Используя библиотеку (NodeJS) +#### Используя библиотеку NodeJS - выполнить `npx assayo` - открыть `./assayo/index.html` -#### Используя библиотеку (PHP) +#### Используя библиотеку PHP - выполнить `composer require bakhirev/assayo` - выполнить `vendor/bin/assayo` - открыть `./assayo/index.html` +#### Используя библиотеку Python +- выполнить `pipx install assayo` +- выполнить `assayo` +- открыть `./assayo/index.html` + +#### Используя библиотеку Ruby +- выполнить `gem install assayo` +- выполнить `assayo` +- открыть `./assayo/index.html` + #### Без установки библиотек - скачать этот репозиторий - перетащить файл `log.txt` в папку `/build` - запустить `/build/index.html` - или перетащить папку `/build` к себе в репозиторий (туда, где лежит `log.txt`). Можно сменить название. Например с `/build` на `/report` В этом случае важно, чтобы файл `log.txt` был сгенерирован командой для офлайн просмотра. - + ### 🏭 Как пересобрать файл отчёта из исходного кода? - Скачать этот репозиторий - Выполнить `npm install` - Выполнить `npm run build:local` - Свежая сборка будет в папке `/build` - + ### 🗃️ Как посмотреть отчёт по группе микросервисов? - Сгенерировать для каждого микросервиса файл `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`). - + ### 🎨 Как брендировать интерфейс? Вы можете написать свою тему для интерфейса. Можно менять: - **Заголовок**. Вы можете указать его в URL-параметре ```title```. Например: ```?title=You Company``` - **Визуальную тему**. Для этого нужно подготовить CSS файл с новыми стилями и указать его адрес в URL-параметре ```theme```. Например: ```?theme=//company.com/some.css```. Вы можете использовать имена классов в качестве селекторов. Большинство из них не меняется в при выходе новой версий. - **Язык**. Вы можете указать его в URL-параметре ```lang```. Например: ```?lang=es``` - + ### 📝 Как подписывать коммиты? Следуйте практике [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Например: ``` @@ -162,9 +189,9 @@ JIRA-1234 feat(profile): Added avatar for user - тип работы `(feat, fix, style, refactor, test, doc и т.д.)` - фича `(profile - раздел сайта, страница или новый функционал, одним словом)` - какую проблему решали `(Added avatar for user)` - + ### 👮 Как добавить проверку текста коммита? - + #### Используя файл `commit-msg` 1. Создайте файл `commit-msg` в папке `.git/hooks/` 2. Добавьте в файл следующий текст: @@ -175,7 +202,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Используя пакет [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Добавьте в файл `package.json` блок `commit-msg`: ``` @@ -187,27 +214,27 @@ fi ... ``` 2. Выполните команду `npm install pre-commit` - + ### 📚 Как автоматизировать сбор данных? - + #### С бекендом - используйте модуль [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### Без бекенда - создайте клон нужного вам репозитория; - скопируйте в корень папку `build`; - откройте `build/index.html` в браузере и добавьте в закладки; - добавьте ярлык на `build/assets/ci-cd.sh` в папку автозагрузки (Windows); Каждый раз, при перезагрузке компьютера, скрипт будет обновлять статистику по всем данным, которые автоматически влились в основную ветку. - + ### 🛠️ DevOps (CI/CD) - + #### Публичный сервер Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://assayo.online/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### Приватный сервер - скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo); - поднимите его в локальной сети; @@ -218,23 +245,23 @@ assayo_url - URL адресс контейнера assayo, он слушает 8 you_url - URL адресс вашего контейнера с логами git; ``` По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт. - + #### Обновление Docker-образа - собрать билд ```npm run build:docker``` - собрать образ ```docker build -t assayo .``` - визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```; - поставить тег ```docker tag assayo bakhirev/assayo:latest```; - запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ О приложении - + #### 📐 Архитектура 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 файл с данными. - + #### 🈯 Релизы, примерно, раз в полгода. Что дальше: - больше советов и достижений; - итоги года / месяца, печать отчётов; @@ -242,11 +269,11 @@ you_url - URL адресс вашего контейнера с логами - анализ файлов; - разные роли для статистики (скрытие финансов); - разработка бекенда, интеграции с другими системами; - + #### 🗺️ Как добавить или отредактировать перевод? Вы можете добавить новый перевод или поправить текущий в разделе ```ts/translations/```. [Инструкция](https://github.com/firstcontributions/first-contributions) - + #### 📧 Пожелания, предложения, замечания - telegramm [@bakhirev](https://t.me/bakhirev) (приоритетный способ связи) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/ZH.md b/documents/ZH.md index 2092dc8..7b641f9 100644 --- a/documents/ZH.md +++ b/documents/ZH.md @@ -41,28 +41,30 @@ Links: [示范表现](https://assayo.online/demo/?ref=github&lang=zh&dump=./test - [If you use PowerShell in Windows](#link-10) - [如何在线查看报告？](#link-11) - [Using website](#link-12) - - [Use the library ](#link-13) - - [Use the library ](#link-14) - - [Use source code](#link-15) -- [如何重打包报告文件？](#link-16) -- [如何查看微服务组的报告？](#link-17) -- [如何将界面重新配色为公司专有颜色？](#link-18) -- [如何签署提交？](#link-19) -- [How to add checking for commit message?](#link-20) - - [ Use file commit-msg](#link-21) - - [ Use package pre-commit](#link-22) -- [如何自动化数据采集？](#link-23) - - [With backend](#link-24) - - [没有后端](#link-25) -- [DevOps ](#link-26) - - [公共服务器](#link-27) - - [专用服务器](#link-28) - - [Docker 图像更新](#link-29) -- [️ About application](#link-30) - - [Architecture](#link-31) - - [释出版本大约每半年一次。接下来发生什么情况：](#link-32) - - [如何添加或编辑翻译？](#link-33) - - [愿望，建议，意见](#link-34) + - [Use the library NodeJS](#link-13) + - [Use the library PHP](#link-14) + - [Use the library Python](#link-15) + - [Use the library Ruby](#link-16) + - [Use source code](#link-17) +- [如何重打包报告文件？](#link-18) +- [如何查看微服务组的报告？](#link-19) +- [如何将界面重新配色为公司专有颜色？](#link-20) +- [如何签署提交？](#link-21) +- [How to add checking for commit message?](#link-22) + - [ Use file commit-msg](#link-23) + - [ Use package pre-commit](#link-24) +- [如何自动化数据采集？](#link-25) + - [With backend](#link-26) + - [没有后端](#link-27) +- [DevOps ](#link-28) + - [公共服务器](#link-29) + - [专用服务器](#link-30) + - [Docker 图像更新](#link-31) +- [️ About application](#link-32) + - [Architecture](#link-33) + - [释出版本大约每半年一次。接下来发生什么情况：](#link-34) + - [如何添加或编辑翻译？](#link-35) + - [愿望，建议，意见](#link-36) ### 🚀 如何 quickly 查阅 commit 的 次数？ 在项目的根目录中执行以下命令： @@ -85,6 +87,11 @@ Python: pipx install assayo assayo ``` +Ruby: +``` +gem install assayo +assayo +``` The script will create a folder `./assayo` with a report about repository: ``` ./assayo/index.html - report @@ -124,46 +131,56 @@ By default, the output encoding may not match UTF-8 and the resulting log file w ``` Or open a saved file and manually change the encoding to UTF-8. -### 如何在线查看报告？ +### 📈 如何在线查看报告？ -#### 📈 Using website +#### Using website - 切换到 [网站](https://assayo.online/) - 按下按钮 “[示范](https://assayo.online/demo?lang=ru)” - 拖放文件 `log.txt` 在浏览器窗口中 -#### Use the library (NodeJS) +#### Use the library NodeJS - run `npx assayo` - open `./assayo/index.html` -#### Use the library (PHP) +#### Use the library PHP - run `composer require bakhirev/assayo` - run `vendor/bin/assayo` - open `./assayo/index.html` +#### Use the library Python +- run `pipx install assayo` +- run `assayo` +- open `./assayo/index.html` + +#### Use the library Ruby +- run `gem install assayo` +- run `assayo` +- open `./assayo/index.html` + #### Use source code - 下载这个存储库 - 拖放文件 `log.txt` 到文件夹 `/build` - 要运行 `/build/index.html` - 或是拖放文件夹 `/build` 到我的仓库 (它所在的地方 `log.txt`). 可以改变名称。比如，从名称 `/build` 到名称 `/report` 重要的事情是，必须让log.txt这个文件是通过命令创建出来的，这样它就可以在没有网的时候查看了。 - + ### 🏭 如何重打包报告文件？ - 下载这个储存库 - 要执行 `npm install` - 要执行 `npm run build:local` - 最新的构建将在文件夹 `/build` - + ### 🗃️ 如何查看微服务组的报告？ - 为每个微服务生成文件 `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) - 参见“如何在有网络环境下查看报告”。在最后一步，将所有文件同时拖入浏览器窗口。 - 参见“如何在没有网络环境下查看报告”。第二步将所有微服务文件拖动到 (`log-1.txt`, `log-2.txt`, `log-3.txt` 等等) 到报表文件夹 (`/build`). - + ### 🎨 如何将界面重新配色为公司专有颜色？ 您可以为界面创建自己的主题。可以修改： - **标题**. 你可以在网址参数中指定它 ```title```. 例如: ```?title=You Company``` - **CSS样式**. 为了做到这一点，你需要准备一个CSS文件并在网址参数中指明其地址 ```theme```. 例如: ```?theme=//company.com/some.css```. 你可以使用类名作为选择器。大多数情况下，他们在新版本发布时不会发生变化。 - **语言**. 你可以把它放在网址的参数中。 ```lang```. 例如: ```?lang=es``` - + ### 📝 如何签署提交？ 遵循实践 [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). 例如: ``` @@ -173,9 +190,9 @@ JIRA-1234 feat(profile): Added avatar for user - 工作类别 `(feat, fix, style, refactor, test, doc 等等)` - 工作领域 `(profile - 地盘组, 网页 或新功能, 一句话)` - 职位描述 `(Added avatar for user)` - + ### 👮 How to add checking for commit message? - + #### Use file `commit-msg` 1. Create file `commit-msg` in folder `.git/hooks/` 2. Add this text in file: @@ -186,7 +203,7 @@ if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)(( exit 1 fi ``` - + #### Use package [pre-commit](https://www.npmjs.com/package/pre-commit) 1. Add in file `package.json` property `commit-msg`: ``` @@ -198,27 +215,27 @@ fi ... ``` 2. Run command `npm install pre-commit` - + ### 📚 如何自动化数据采集？ - + #### With backend - use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler); - + #### 没有后端 - 克隆您的仓库; - 复制文件夹 `build` 从当前仓库; - 打开 `build/index.html` 在浏览器中添加书签; - 添加一个快捷方式 `build/assets/ci-cd.sh` 自动启动文件夹 (Windows); 每次重启计算机，该脚本将更新统计数据，这些数据自动添加到主分支中。 - + ### 🛠️ DevOps (CI/CD) - + #### 公共服务器 您可以将数据构建报告文件发布到公共URL，可以使用网站来显示它。 [assayo](https://assayo.online/). 指定数据所在的地址作为URL参数 ```dump```: ``` https://assayo.online/demo/?dump=//you_site.com/some/log.txt ``` - + #### 专用服务器 - 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo); - 在本地网络中运行它; @@ -229,30 +246,30 @@ assayo_url - assayo容器的URL地址，它监听80端口; you_url - git日志的容器的URL地址; ``` 默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用. - + #### Docker 图像更新 - 运行命令 ```npm run build:docker``` - 运行命令 ```docker build -t assayo .``` - 检查结果 ```docker run --name assayo -p 80:80 -d assayo```; - 运行命令 ```docker tag assayo bakhirev/assayo:latest```; - 提交容器映像到 Docker Hub ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application - + #### 📐 Architecture 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. - + #### 🈯 释出版本大约每半年一次。接下来发生什么情况： 看 [主要文件](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) - + #### 🗺️ 如何添加或编辑翻译？ 您可以在“翻译”部分添加新翻译或更正当前翻译。 ```ts/translations/```. [指示手册](https://github.com/firstcontributions/first-contributions) - + #### 📧 愿望，建议，意见 - telegramm [@bakhirev](https://t.me/bakhirev) (优先通信方法) - [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) diff --git a/documents/src/json/de.json b/documents/src/json/de.json index d3e890a..fde18d7 100644 --- a/documents/src/json/de.json +++ b/documents/src/json/de.json @@ -84,6 +84,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -167,7 +176,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -176,7 +185,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -185,6 +194,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/en.json b/documents/src/json/en.json index 85631fc..08b1b85 100644 --- a/documents/src/json/en.json +++ b/documents/src/json/en.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/es.json b/documents/src/json/es.json index c4a16e5..4aed01a 100644 --- a/documents/src/json/es.json +++ b/documents/src/json/es.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/fr.json b/documents/src/json/fr.json index 8504fbc..5db3b00 100644 --- a/documents/src/json/fr.json +++ b/documents/src/json/fr.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/ja.json b/documents/src/json/ja.json index a6b129e..f3e1275 100644 --- a/documents/src/json/ja.json +++ b/documents/src/json/ja.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/pt.json b/documents/src/json/pt.json index 0a30ef3..0669506 100644 --- a/documents/src/json/pt.json +++ b/documents/src/json/pt.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/json/ru.json b/documents/src/json/ru.json index 1e7aaa5..30011fe 100644 --- a/documents/src/json/ru.json +++ b/documents/src/json/ru.json @@ -56,16 +56,44 @@ ] }, { - "h3": "Как создать отчёт?" + "h3": "Как создать отчёт с помощью библиотеки?" }, + { - "p": "Если у вас установлен NodeJS, то вы можете выполнить:" + "p": "NodeJS:" }, { "pre": [ "npx assayo" ] }, + { + "p": "PHP:" + }, + { + "pre": [ + "composer require bakhirev/assayo", + "vendor/bin/assayo" + ] + }, + { + "p": "Python:" + }, + { + "pre": [ + "pipx install assayo", + "assayo" + ] + }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "Скрипт создаст папку `./assayo` с отчётом по данному репозиторию:" }, @@ -149,7 +177,7 @@ ] }, { - "h4": "Используя библиотеку (NodeJS)" + "h4": "Используя библиотеку NodeJS" }, { "li": [ @@ -158,7 +186,7 @@ ] }, { - "h4": "Используя библиотеку (PHP)" + "h4": "Используя библиотеку PHP" }, { "li": [ @@ -167,6 +195,26 @@ "открыть `./assayo/index.html`" ] }, + { + "h4": "Используя библиотеку Python" + }, + { + "li": [ + "выполнить `pipx install assayo`", + "выполнить `assayo`", + "открыть `./assayo/index.html`" + ] + }, + { + "h4": "Используя библиотеку Ruby" + }, + { + "li": [ + "выполнить `gem install assayo`", + "выполнить `assayo`", + "открыть `./assayo/index.html`" + ] + }, { "h4": "Без установки библиотек" }, diff --git a/documents/src/json/zh.json b/documents/src/json/zh.json index 68066e8..73342eb 100644 --- a/documents/src/json/zh.json +++ b/documents/src/json/zh.json @@ -87,6 +87,15 @@ "assayo" ] }, + { + "p": "Ruby:" + }, + { + "pre": [ + "gem install assayo", + "assayo" + ] + }, { "p": "The script will create a folder `./assayo` with a report about repository:" }, @@ -170,7 +179,7 @@ ] }, { - "h4": "Use the library (NodeJS)" + "h4": "Use the library NodeJS" }, { "li": [ @@ -179,7 +188,7 @@ ] }, { - "h4": "Use the library (PHP)" + "h4": "Use the library PHP" }, { "li": [ @@ -188,6 +197,26 @@ "open `./assayo/index.html`" ] }, + { + "h4": "Use the library Python" + }, + { + "li": [ + "run `pipx install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, + { + "h4": "Use the library Ruby" + }, + { + "li": [ + "run `gem install assayo`", + "run `assayo`", + "open `./assayo/index.html`" + ] + }, { "h4": "Use source code" }, diff --git a/documents/src/lib/JsonToMd/TableOfContent.js b/documents/src/lib/JsonToMd/TableOfContent.js index 890af95..49f95df 100644 --- a/documents/src/lib/JsonToMd/TableOfContent.js +++ b/documents/src/lib/JsonToMd/TableOfContent.js @@ -10,11 +10,13 @@ const SMILES = [ null, // 8 null, // 8 null, // 8 - null, // 9 '📈', // 10 null, // 9 + null, // 9 null, // 11 null, // 12 + null, // 12 + null, // 12 '🏭', // 13 '🗃️', // 14 '🎨', // 15