{"id":28610091,"url":"https://github.com/bakhirev/assayo","last_synced_at":"2025-06-11T22:33:12.373Z","repository":{"id":164414463,"uuid":"639858939","full_name":"bakhirev/assayo","owner":"bakhirev","description":"git log analysis and visualization for team lead","archived":false,"fork":false,"pushed_at":"2025-05-20T19:55:33.000Z","size":30704,"stargazers_count":253,"open_issues_count":20,"forks_count":23,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-20T21:49:36.826Z","etag":null,"topics":["achivments","audit","commit","data-visualization","git","log","osint","report","statistics"],"latest_commit_sha":null,"homepage":"https://bakhirev.github.io/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bakhirev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"bakhirev","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2023-05-12T11:43:20.000Z","updated_at":"2025-05-20T19:55:38.000Z","dependencies_parsed_at":"2024-07-19T02:32:41.232Z","dependency_job_id":"ab58f568-5431-4911-b9c7-8298f11d5775","html_url":"https://github.com/bakhirev/assayo","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bakhirev/assayo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bakhirev%2Fassayo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bakhirev%2Fassayo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bakhirev%2Fassayo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bakhirev%2Fassayo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bakhirev","download_url":"https://codeload.github.com/bakhirev/assayo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bakhirev%2Fassayo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259354987,"owners_count":22844968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["achivments","audit","commit","data-visualization","git","log","osint","report","statistics"],"created_at":"2025-06-11T22:32:21.169Z","updated_at":"2025-06-11T22:33:12.363Z","avatar_url":"https://github.com/bakhirev.png","language":"TypeScript","funding_links":["https://github.com/sponsors/bakhirev"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e __[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)\n\n\u003e The [main documentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) is in russian. This is a translation. It may contain errors. If you a native speaker, you can help improve this translation. Thanks!\n\n# [Assayo](https://bakhirev.github.io/?ref=github\u0026lang=en)\nVisualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit\n\n**Links:** [demo](https://bakhirev.github.io/demo/?ref=github\u0026dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/).\n\n**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ).\n\n\u003ca href=\"http://www.facebook.com/sharer.php?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/facebook.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://reddit.com/submit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/reddit.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\u0026via=\u0026hashtags=IT%2Cgit%2Cstatistics%2Caudit%2Cdata-visualization%2Creport\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/twitter.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/linkedin.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://www.tumblr.com/widgets/share/tool?canonicalUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository\u0026caption=Check%20your%20git%20stats%21\u0026tags=IT%2Cgit%2Cstatistics%2Caudit%2Cdata-visualization%2Creport\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/tumblr.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://www.blogger.com/blog-this.g?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026n=Visualization%20and%20analysis%20of%20git%20repository\u0026t=Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/blogger.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://www.evernote.com/clip.action?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/evernote.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://www.addthis.com/bookmark.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/add.this.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://getpocket.com/edit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/getpocket.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026t=Visualization%20and%20analysis%20of%20git%20repository\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/hacker.news.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://buffer.com/add?text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\u0026url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/buffer.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://share.flipboard.com/bookmarklet/popout?v=2\u0026title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\u0026url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/flipboard.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://www.instapaper.com/edit?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository\u0026description=Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/instapaper.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://share.diasporafoundation.org/?title=Visualization%20and%20analysis%20of%20git%20repository\u0026url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/diaspora.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://sns.qzone.qq.com/cgi-bin/qzshare/cgi_qzshare_onekey?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/qzone.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://vk.com/share.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository\u0026comment=Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/vk.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://service.weibo.com/share/share.php?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026appkey=\u0026title=Visualization%20and%20analysis%20of%20git%20repository\u0026pic=\u0026ralateUid=\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/weibo.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://connect.ok.ru/dk?st.cmd=WidgetSharePreview\u0026st.shareUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/ok.ru.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://www.douban.com/recommend/?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/douban.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://www.xing.com/spi/shares/new?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/xing.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"http://widget.renren.com/dialog/share?resourceUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026srcUrl=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026title=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\u0026description=Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/renren.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"threema://compose?text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\u0026id=\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/threema.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\u003ca href=\"https://lineit.line.me/share/ui?url=https%3A%2F%2Fgithub.com%2Fbakhirev%2Fassayo\u0026text=Visualization%20and%20analysis%20of%20git%20repository%20%3A%20Check%20your%20git%20stats%21\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/seo/social/line.me.jpg\" title=\"Visualization and analysis of git repository\" width=\"24px\" height=\"24px\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://bakhirev.github.io/demo/?dump=./test.txt\" target=\"_blank\"\u003e\u003cimg src=\"https://bakhirev.github.io/assets/images/index.gif\" width=\"100%\" /\u003e\u003c/a\u003e\n\n\u003ca name=\"link-0\"\u003e\u003c/a\u003e\n##### 👨‍💻 Employee can evaluate new workplace\n- work speed;\n- number of extra hours worked;\n- areas of competence;\n- volume of features and bugs;\n- working style of colleagues;\n  \u003ca name=\"link-1\"\u003e\u003c/a\u003e\n##### ‍👨‍💼 Team lead can evaluate employees\n- identify slackers;\n- estimate the amount of code;\n- learn the work speed;\n- notice behavioral anomalies;\n- see the dynamics of work by week;\n  \u003ca name=\"link-2\"\u003e\u003c/a\u003e\n##### 👑 Founder can evaluate product\n- product cost;\n- cost of features;\n- development time;\n- forecast of rework time;\n- forecast cost;\n  \u003ca name=\"link-3\"\u003e\u003c/a\u003e\n###  Table of contents\n- [How to quickly view the number of commits?](#link-4)\n- [How to create a local report with using library?](#link-5)\n- [How to concat authors?](#link-6)\n- [How to export data from git?](#link-7)\n  - [For online viewing](#link-8)\n  - [For offline viewing](#link-9)\n  - [If you use PowerShell in Windows](#link-10)\n- [How to view the report?](#link-11)\n  - [Using website](#link-12)\n  - [Use the library NodeJS](#link-13)\n  - [Use the library PHP](#link-14)\n  - [Use the library Python](#link-15)\n  - [Use the library Ruby](#link-16)\n  - [Use the library Go](#link-165)\n  - [Use source code](#link-17)\n- [How to rebuild the HTML report from source code?](#link-18)\n- [How to view a report on a group of microservices?](#link-19)\n- [How to brand the interface?](#link-20)\n- [How to sign commits?](#link-21)\n- [How to add checking for commit message?](#link-22)\n  - [Use file commit-msg](#link-23)\n  - [Use package pre-commit](#link-24)\n- [How to automate data collection?](#link-25)\n  - [With backend](#link-26)\n  - [Without backend](#link-27)\n- [DevOps ](#link-28)\n  - [Public server](#link-29)\n  - [Private server](#link-30)\n  - [How to update the Docker image?](#link-31)\n- [️ About application](#link-32)\n  - [Architecture](#link-33)\n  - [How to add or edit a translation?](#link-34)\n  - [RoadMap:](#link-35)\n  - [Feedback, comments](#link-36)\n    \u003ca name=\"link-4\"\u003e\u003c/a\u003e\n### 🚀 How to quickly view the number of commits?\nIn the root directory of your project, run:\n```\ngit shortlog -s -n -e\n```\n\u003ca name=\"link-5\"\u003e\u003c/a\u003e\n### 🏭 How to create a local report with using library?\nNodeJS:\n```\nnpx assayo\n```\nPHP:\n```\ncomposer require bakhirev/assayo\nvendor/bin/assayo\n```\nPython:\n```\npipx install assayo\nassayo\n```\nRuby:\n```\ngem install assayo\nassayo\n```\nGo:\n```\ngo get github.com/bakhirev/assayo\ngo install github.com/bakhirev/assayo\nassayo\n```\nThe script will create a folder `./assayo` with a report about repository:\n```\n./assayo/index.html - report\n./assayo/log.txt    - information from git\n```\nIf you do not have NodeJS/PHP , see the items \"How to download data from git?\" and \"How to view the report?\"\n\u003ca name=\"link-6\"\u003e\u003c/a\u003e\n### ‍🎭 How to concat authors?\nIn the root directory of your project, you need to create a `.mailmap` file.\nExample of the contents of the file:\n```\nAlex B \u003calex@mail.uk\u003e\nAlex B \u003calex@mail.uk\u003e \u003calex@gov.tk\u003e\nAlex B \u003calex@mail.uk\u003e \u003cbakhirev@ya.kz\u003e\nAlex B \u003calex@mail.uk\u003e \u003cman64@yahoo.com\u003e\n```\nRead more about the format of this file you can [here](https://git-scm.com/docs/gitmailmap).\n\u003ca name=\"link-7\"\u003e\u003c/a\u003e\n### 📤 How to export data from git?\n\u003ca name=\"link-8\"\u003e\u003c/a\u003e\n####  For online viewing\nIn the root directory of your project run:\n```\ngit --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:\"%ad\u003e%aN\u003e%aE\u003e%s\" \u003e log.txt\n```\n\u003ca name=\"link-9\"\u003e\u003c/a\u003e\n####  For offline viewing\n```\ngit --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:\"%ad\u003e%aN\u003e%aE\u003e%s\" | sed -e 's/\\\\/\\\\\\\\/g' | sed -e 's/`/\"/g' | sed -e 's/\\$/S/g' | sed -e '1s/^/R(f\\`/' | sed -e '$s/$/\\`\\);/' \u003e log.txt\n```\nGit will create a file `log.txt`. This file contains data for show a report. The difference between the online and offline format is the presence of a wrapper for strings. The offline format will be pulled up like a `js` file if you just opened `/build/index.html `\n\u003ca name=\"link-10\"\u003e\u003c/a\u003e\n####  If you use PowerShell in Windows\nBy default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command.\n```\n[Console]::OutputEncoding = [System.Text.Encoding]::UTF8\n```\nOr open a saved file and manually change the encoding to UTF-8.\n\u003ca name=\"link-11\"\u003e\u003c/a\u003e\n### 📈 How to view the report?\n\u003ca name=\"link-12\"\u003e\u003c/a\u003e\n####  Using website\n- go to the [website](https://bakhirev.github.io/);\n- click the “[Demo](https://bakhirev.github.io/demo?ref=github\u0026lang=en)” button;\n- drop the `log.txt` file into the browser window;\n  \u003ca name=\"link-13\"\u003e\u003c/a\u003e\n####  Use the library NodeJS\n- run `npx assayo`\n- open `./assayo/index.html`\n  \u003ca name=\"link-14\"\u003e\u003c/a\u003e\n####  Use the library PHP\n- run `composer require bakhirev/assayo`\n- run `vendor/bin/assayo`\n- open `./assayo/index.html`\n  \u003ca name=\"link-15\"\u003e\u003c/a\u003e\n####  Use the library Python\n- run `pipx install assayo`\n- run `assayo`\n- open `./assayo/index.html`\n  \u003ca name=\"link-16\"\u003e\u003c/a\u003e\n####  Use the library Ruby\n- run `gem install assayo`\n- run `assayo`\n- open `./assayo/index.html`\n  \u003ca name=\"link-165\"\u003e\u003c/a\u003e\n####  Use the library Go\n- run `go get github.com/bakhirev/assayo`\n- run `go install github.com/bakhirev/assayo`\n- run `assayo`\n- open `./assayo/index.html`\n  \u003ca name=\"link-17\"\u003e\u003c/a\u003e\n####  Use source code\n- download this repository `git clone https://github.com/bakhirev/assayo.git`;\n- drop the `log.txt` file to the `/build` folder;\n- run `/build/index.html`;\n- 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`.\n  In this case, it is important that the `log.txt` file is generated by the command for offline viewing.\n  \u003ca name=\"link-18\"\u003e\u003c/a\u003e\n### 🏭 How to rebuild the HTML report from source code?\n- download this repository `git clone https://github.com/bakhirev/assayo.git`\n- run `npm install`\n- run `npm run build:local`\n- the new HTML build will be in the `/build` folder\n  \u003ca name=\"link-19\"\u003e\u003c/a\u003e\n### 🗃️ How to view a report on a group of microservices?\n- 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;\n- see “How to view an online report?”. At the last step, drag all the files at once into the browser window.\n- 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`).\n  \u003ca name=\"link-20\"\u003e\u003c/a\u003e\n### 🎨 How to brand the interface?\nYou can create your own interface theme. Options:\n- **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company```\n- **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.\n- **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es```\n\n**Example:** [page](https://bakhirev.github.io/demo/themes/)\n\u003ca name=\"link-21\"\u003e\u003c/a\u003e\n### 📝 How to sign commits?\nFollow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:\n```\nJIRA-1234 feat(profile): Added avatar for user \n```\n- task number in the task tracker `(JIRA-1234)`\n- type of work `(feat, fix, style, refactor, test, doc и т.д.)`\n- feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`\n- what problem were solved `(Added avatar for user)`\n  \u003ca name=\"link-22\"\u003e\u003c/a\u003e\n### 👮 How to add checking for commit message?\n\u003ca name=\"link-23\"\u003e\u003c/a\u003e\n####  Use file `commit-msg`\n1. Create file `commit-msg` in folder `.git/hooks/`\n2. Add this text in file:\n```\n#!/usr/bin/env bash\nif ! 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\n   echo \"Need commit message like: JIRA-12 fix(profile): some text. Read Semantic Commit Messages\" \u003e\u00262\n   exit 1\nfi\n```\n\u003ca name=\"link-24\"\u003e\u003c/a\u003e\n####  Use package [pre-commit](https://www.npmjs.com/package/pre-commit)\n1. Add in file `package.json` property `commit-msg`:\n```\n  ...\n  \"commit-msg\": {\n    \"regex\": \"(JIRA-[0-9]{1,5})(\\\\s)(feat|fix|docs|style|refactor|test|chore)((\\\\([a-z0-9_-]{1,}\\\\)){0,})(:\\\\s)([a-z]{1,})\",\n    \"error-message\": \"Need commit message like: JIRA-12 fix(profile): some text Read Semantic Commit Messages\"\n  },\n  ...\n```\n2. Run command `npm install pre-commit`\n   \u003ca name=\"link-25\"\u003e\u003c/a\u003e\n### 📚 How to automate data collection?\n\u003ca name=\"link-26\"\u003e\u003c/a\u003e\n####  With backend\n- use module [Assayo Crawler](https://github.com/bakhirev/assayo-crawler);\n  \u003ca name=\"link-27\"\u003e\u003c/a\u003e\n####  Without backend\n- create a clone of the repository you need;\n- copy the `build` folder to the root;\n- open `build/index.html` in the browser and add it to bookmarks;\n- add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows);\n  Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch.\n  \u003ca name=\"link-28\"\u003e\u003c/a\u003e\n### 🛠️ DevOps (CI/CD)\n\u003ca name=\"link-29\"\u003e\u003c/a\u003e\n####  Public server\nYou can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github\u0026lang=en) to visualize it.\n```\nhttps://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt\n```\n\u003ca name=\"link-30\"\u003e\u003c/a\u003e\n####  Private server\n- download the [docker image](https://hub.docker.com/r/bakhirev/assayo);\n- run it on your local network;\n- use the web interface to view the reports, set the URL of the data in the URL parameter ```dump```:\n```\nhttp://assayo_url/?dump=//you_url/some/log.txt\nassayo_url - URL of the assayo container, it listens on port 80;\nyou_url    - URL of your container with git logs;\n```\nBy default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free.\n\u003ca name=\"link-31\"\u003e\u003c/a\u003e\n####  How to update the Docker image?\n- run ```npm run build:docker```\n- run ```docker build -t assayo .```\n- visually check the image ```docker run --name assayo -p 80:80 -d assayo```;\n- add tag ```docker tag assayo bakhirev/assayo:latest```;\n- push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```;\n  \u003ca name=\"link-32\"\u003e\u003c/a\u003e\n### 🛠️ ️ About application\n\u003ca name=\"link-33\"\u003e\u003c/a\u003e\n#### 📐 Architecture\n\u003cimg src=\"https://raw.githubusercontent.com/bakhirev/assayo-crawler/12af4410fc93384cafb108a4429e43f9a874dbaa/schema.svg\" width=\"70%\" /\u003e\n\n1. [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.\n2. [Crawler service](https://github.com/bakhirev/assayo-crawler) collects repository logs for the report.\n3. [Log visualization UI](https://github.com/bakhirev/assayo) **(you here)** displays report. Needs a log file for work.\n   \u003ca name=\"link-34\"\u003e\u003c/a\u003e\n#### 🈯 How to add or edit a translation?\nYou can add a new translation or correct an existing one in the ```ts/translations/``` folder.\n[Instruction](https://github.com/firstcontributions/first-contributions)\n\u003ca name=\"link-35\"\u003e\u003c/a\u003e\n#### 🗺️ RoadMap:\nReleases are planned approximately once every six months. What’s next:\n- more recommendations and achievements;\n- annual/monthly summaries, report printing;\n- localization and internationalization;\n- file analysis;\n- different roles for statistics (hiding finances);\n- development of the backend, integration with other systems;\n  \u003ca name=\"link-36\"\u003e\u003c/a\u003e\n#### 📧 Feedback, comments\n- \u003cimg alt=\"Telegram Messenger\" src=\"https://telegram.org/img/website_icon.svg?4\" style=\"vertical-align: middle;\" /\u003e [@bakhirev](https://t.me/bakhirev) (preferred method of communication)\n- 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru)\n- 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github\u0026lang=en)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbakhirev%2Fassayo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbakhirev%2Fassayo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbakhirev%2Fassayo/lists"}