mirror of
https://github.com/bakhirev/assayo.git
synced 2024-11-16 16:21:41 +00:00
220 lines
19 KiB
Markdown
220 lines
19 KiB
Markdown
> [English](https://github.com/bakhirev/assayo) | [Español](https://github.com/bakhirev/assayo/blob/main/documents/ES.md) | [中文](https://github.com/bakhirev/assayo/blob/main/documents/ZH.md) | [Français](https://github.com/bakhirev/assayo/blob/main/documents/FR.md) | __[Deutsch](https://github.com/bakhirev/assayo/blob/main/documents/DE.md)__ | [Português](https://github.com/bakhirev/assayo/blob/main/documents/PT.md) | [日本語](https://github.com/bakhirev/assayo/blob/main/documents/JA.md) | [Русский](https://github.com/bakhirev/assayo/blob/main/documents/RU.md)
|
||
|
||
|
||
# [Assayo](https://assayo.online/?ref=github&lang=de)
|
||
Visualisierung und analyse ihrer Git-datenbank ([demo](https://assayo.online/demo/?ref=github&lang=de&dump=./test.txt), [install](https://assayo.online/demo/?ref=github)).
|
||
|
||
<a href="http://www.facebook.com/sharer.php?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/facebook.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://reddit.com/submit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository" target="_blank"><img src="https://assayo.online/assets/seo/social/reddit.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21&via=&hashtags=IT%2Cgit%2Cstatistics%2Caudit%2Cdata-visualization%2Creport" target="_blank"><img src="https://assayo.online/assets/seo/social/twitter.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/linkedin.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://www.tumblr.com/widgets/share/tool?canonicalUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository&caption=Check%20your%20git%20stats%21&tags=IT%2Cgit%2Cstatistics%2Caudit%2Cdata-visualization%2Creport" target="_blank"><img src="https://assayo.online/assets/seo/social/tumblr.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://www.blogger.com/blog-this.g?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&n=Visualization%20and%20analysis%20of%20git%20repository&t=Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/blogger.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://www.evernote.com/clip.action?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/evernote.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://www.addthis.com/bookmark.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/add.this.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://getpocket.com/edit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/getpocket.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&t=Visualization%20and%20analysis%20of%20git%20repository" target="_blank"><img src="https://assayo.online/assets/seo/social/hacker.news.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://buffer.com/add?text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21&url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/buffer.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://share.flipboard.com/bookmarklet/popout?v=2&title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21&url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/flipboard.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://www.instapaper.com/edit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository&description=Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/instapaper.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://share.diasporafoundation.org/?title=Visualization%20and%20analysis%20of%20git%20repository&url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/diaspora.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/qzone.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository&comment=Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/vk.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://service.weibo.com/share/share.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&appkey=&title=Visualization%20and%20analysis%20of%20git%20repository&pic=&ralateUid=" target="_blank"><img src="https://assayo.online/assets/seo/social/weibo.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://connect.ok.ru/dk?st.cmd=WidgetSharePreview&st.shareUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/ok.ru.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://www.douban.com/recommend/?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/douban.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://www.xing.com/spi/shares/new?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo" target="_blank"><img src="https://assayo.online/assets/seo/social/xing.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="http://widget.renren.com/dialog/share?resourceUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&srcUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21&description=Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/renren.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="threema://compose?text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21&id=" target="_blank"><img src="https://assayo.online/assets/seo/social/threema.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a><a href="https://lineit.line.me/share/ui?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo&text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21" target="_blank"><img src="https://assayo.online/assets/seo/social/line.me.jpg" title="Visualization and analysis of git repository" width="24px" height="24px"/></a>
|
||
<a href="https://assayo.online/demo/?dump=./test.txt" target="_blank"><img src="https://assayo.online/seo/github/index.png" width="100%" /></a>
|
||
|
||
<a name="link-0"></a>
|
||
##### 👨💻 Mitarbeiter können den neuen arbeitsplatz bewerten
|
||
- arbeitsgeschwindigkeit;
|
||
- anzahl der überstunden;
|
||
- verantwortungsbereiche;
|
||
- umfang des neuen funktionsweise und fehlerbestandes;
|
||
- arbeitsstil der kollegen;
|
||
<a name="link-1"></a>
|
||
##### 👨💼 Der vorgesetzte kann die mitarbeiter bewerten
|
||
- ermitteln sie die untätigen;
|
||
- schätzen sie den codeumfang ab;
|
||
- erfahren sie die arbeitsgeschwindigkeit;
|
||
- merken sie verhaltensanomalien;
|
||
- beobachten sie das arbeitsgeschehen nach wochen;
|
||
<a name="link-2"></a>
|
||
##### 👑 Der Investor kann das produkt bewerten
|
||
- produktpreis;
|
||
- preis des neuen funktionsumfanges;
|
||
- entwicklungszeit;
|
||
- vorhersage der zeit für überarbeitungen;
|
||
- preiskostenprognose;
|
||
<a name="link-3"></a>
|
||
### Table of contents
|
||
- [Wie kann ich die anzahl der commits schnell sehen?](#link-4)
|
||
- [Wie kann ich autoren zusammenbringen?](#link-5)
|
||
- [Wie kann ich daten aus git?](#link-6)
|
||
- [Für die onlineansicht](#link-7)
|
||
- [Zum surfen ohne internet](#link-8)
|
||
- [Wie kann ich den bericht sehen?](#link-9)
|
||
- [Online](#link-10)
|
||
- [Offline](#link-11)
|
||
- [Wie kann ich die berichtsdatei neu erstellen?](#link-12)
|
||
- [Wie kann ich den bericht zur microservices-gruppe anzeigen?](#link-13)
|
||
- [Wie kann ich die benutzeroberfläche in ihren markenfarben neu streichen?](#link-14)
|
||
- [Wie signiere ich commits?](#link-15)
|
||
- [How to add checking for commit message?](#link-16)
|
||
- [ Use file commit-msg](#link-17)
|
||
- [ Use package pre-commit](#link-18)
|
||
- [Wie kann ich die datenerfassung automatisieren?](#link-19)
|
||
- [With backend](#link-20)
|
||
- [Kein bekend](#link-21)
|
||
- [DevOps ](#link-22)
|
||
- [Öffentlicher server](#link-23)
|
||
- [Privater server](#link-24)
|
||
- [Aktualisieren eines Docker-Images](#link-25)
|
||
- [️ About application](#link-26)
|
||
- [Architecture](#link-27)
|
||
- [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-28)
|
||
- [Wie kann ich eine übersetzung hinzufügen oder bearbeiten?](#link-29)
|
||
- [Wünsche, Anregungen, Kommentare](#link-30)
|
||
<a name="link-4"></a>
|
||
### 🚀 Wie kann ich die anzahl der commits schnell sehen?
|
||
In der wurzelverzeichnis ihres projektes muss der befehl ausgeführt werden:
|
||
```
|
||
git shortlog -s -n -e
|
||
```
|
||
<a name="link-5"></a>
|
||
### 🎭 Wie kann ich autoren zusammenbringen?
|
||
Sie müssen eine datei im stammverzeichnis ihres projekts erstellen `.mailmap`.
|
||
Beispiel für den Inhalt einer Datei:
|
||
```
|
||
Alex B <alex@mail.uk>
|
||
Alex B <alex@mail.uk> <alex@gov.tk>
|
||
Alex B <alex@mail.uk> <bakhirev@ya.kz>
|
||
Alex B <alex@mail.uk> <man64@yahoo.com>
|
||
```
|
||
Sie können mehr über das format dieser datei lesen[hier](https://git-scm.com/docs/gitmailmap).
|
||
<a name="link-6"></a>
|
||
### 📤 Wie kann ich daten aus git?
|
||
<a name="link-7"></a>
|
||
#### Für die onlineansicht
|
||
In der wurzelverzeichnis ihres projektes ausführen:
|
||
```
|
||
git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" > log.txt
|
||
```
|
||
<a name="link-8"></a>
|
||
#### Zum surfen ohne internet
|
||
```
|
||
git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%cN>%cE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/^/report.push(\`/g' | sed 's/$/\`\);/g' | sed 's/\$/_/g' > log.txt
|
||
```
|
||
Git erstellt eine datei `log.txt`.
|
||
Diese datei enthält die daten zum erstellen des berichts.
|
||
Der unterschied zwischen den formaten liegt im vorhandensein einer wrapper für zeilen. Das format ohne internet wird wie eine js-datei geladen, wenn sie es einfach öffnen. `/build/index.html`
|
||
<a name="link-9"></a>
|
||
### 📈 Wie kann ich den bericht sehen?
|
||
<a name="link-10"></a>
|
||
#### Online
|
||
- gehe zu [Webseite](https://assayo.online/)
|
||
- den knopf drücken “[Demonstration](https://assayo.online/demo?lang=ru)”
|
||
- datei ziehen `log.txt` in das Browserfenster
|
||
<a name="link-11"></a>
|
||
#### Offline
|
||
- 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.
|
||
<a name="link-12"></a>
|
||
### 🏭 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-13"></a>
|
||
### 🗃️ 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-14"></a>
|
||
### 🎨 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```
|
||
<a name="link-15"></a>
|
||
### 📝 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
|
||
```
|
||
- aufgabennummer `(JIRA-1234)`
|
||
- 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)`
|
||
<a name="link-16"></a>
|
||
### 👮 How to add checking for commit message?
|
||
<a name="link-17"></a>
|
||
#### Use file `commit-msg`
|
||
1. Create file `commit-msg` in folder `.git/hooks/`
|
||
2. Add this text in file:
|
||
```
|
||
#!/usr/bin/env bash
|
||
if ! grep -iqE "(JIRA-[0-9]{1,5})(\s)(feat|fix|docs|style|refactor|test|chore)((\([a-z0-9_-]{1,}\)){0,})(:\s)([a-z]{1,})" "$1"; then
|
||
echo "Need commit message like: JIRA-12 fix(profile): some text. Read Semantic Commit Messages" >&2
|
||
exit 1
|
||
fi
|
||
```
|
||
<a name="link-18"></a>
|
||
#### Use package [pre-commit](https://www.npmjs.com/package/pre-commit)
|
||
1. Add in file `package.json` property `commit-msg`:
|
||
```
|
||
...
|
||
"commit-msg": {
|
||
"regex": "(JIRA-[0-9]{1,5})(\\s)(feat|fix|docs|style|refactor|test|chore)((\\([a-z0-9_-]{1,}\\)){0,})(:\\s)([a-z]{1,})",
|
||
"error-message": "Need commit message like: JIRA-12 fix(profile): some text Read Semantic Commit Messages"
|
||
},
|
||
...
|
||
```
|
||
2. Run command `npm install pre-commit`
|
||
<a name="link-19"></a>
|
||
### 📚 Wie kann ich die datenerfassung automatisieren?
|
||
<a name="link-20"></a>
|
||
#### With backend
|
||
- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);
|
||
<a name="link-21"></a>
|
||
#### 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.
|
||
<a name="link-22"></a>
|
||
### 🛠️ DevOps (CI/CD)
|
||
<a name="link-23"></a>
|
||
#### Ö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
|
||
```
|
||
<a name="link-24"></a>
|
||
#### 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```:
|
||
```
|
||
http://assayo_url/?dump=//you_url/some/log.txt
|
||
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.
|
||
<a name="link-25"></a>
|
||
#### Aktualisieren eines Docker-Images
|
||
- befehl ausführen ```npm run build-local```
|
||
- 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```;
|
||
<a name="link-26"></a>
|
||
### 🛠️ ️ About application
|
||
<a name="link-27"></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-28"></a>
|
||
#### 🈯 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-29"></a>
|
||
#### 🗺️ 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-30"></a>
|
||
#### 📧 Wünsche, Anregungen, Kommentare
|
||
- telegramm [@bakhirev](https://t.me/bakhirev) (vorrangiger kommunikationsweg)
|
||
- [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)
|
||
- web site [https://assayo.online/](https://assayo.online/?ref=github&lang=de)
|
||
|
||
<img src="https://mc.yandex.ru/watch/94903985" style="position:absolute; left:-9999px;" alt="" />
|