{"id":29555457,"url":"https://github.com/hpicgs/github-software-analytics-embedding","last_synced_at":"2025-07-18T09:02:34.920Z","repository":{"id":41206486,"uuid":"488979570","full_name":"hpicgs/github-software-analytics-embedding","owner":"hpicgs","description":"Seminar Project of the Seminar \"Advanced Techniques for Analysis and Visualization of Software Data\" of CGS, HPI and DEF in the Summer Term 2022","archived":false,"fork":false,"pushed_at":"2024-12-10T19:59:48.000Z","size":8084,"stargazers_count":2,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2025-07-16T21:06:46.136Z","etag":null,"topics":["code-analysis","data-visualization","github-actions","typescript"],"latest_commit_sha":null,"homepage":"https://hpicgs.github.io/github-software-analytics-embedding","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hpicgs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-05-05T13:17:08.000Z","updated_at":"2024-12-10T19:59:19.000Z","dependencies_parsed_at":"2024-01-24T21:24:04.137Z","dependency_job_id":"092525d4-e9fc-4c91-8817-c513132ee35e","html_url":"https://github.com/hpicgs/github-software-analytics-embedding","commit_stats":{"total_commits":131,"total_committers":4,"mean_commits":32.75,"dds":"0.10687022900763354","last_synced_commit":"5d99d0de266fa2ddf72fe019c043476de01f3829"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/hpicgs/github-software-analytics-embedding","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpicgs%2Fgithub-software-analytics-embedding","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpicgs%2Fgithub-software-analytics-embedding/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpicgs%2Fgithub-software-analytics-embedding/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpicgs%2Fgithub-software-analytics-embedding/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hpicgs","download_url":"https://codeload.github.com/hpicgs/github-software-analytics-embedding/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hpicgs%2Fgithub-software-analytics-embedding/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265688867,"owners_count":23811509,"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":["code-analysis","data-visualization","github-actions","typescript"],"created_at":"2025-07-18T09:01:50.910Z","updated_at":"2025-07-18T09:02:30.306Z","avatar_url":"https://github.com/hpicgs.png","language":"JavaScript","readme":"# github-software-analytics-embedding\nSeminar Project of the Seminar \"Advanced Techniques for Analysis and Visualization of Software Data\" of CGS, HPI and DEF in the Summer Term 2022\n\n![image](https://user-images.githubusercontent.com/33397387/194839012-0c3efa5c-29cf-41b3-a686-1e9fd310c1a2.png)\nThis project contains:\n- a dockerized github action to calculate typescript software metrics per commit and store them as a `.csv` file directly to the git repository under the custom ref `refs/metrics`.\n- a React frontend to visualize the calculated metrics in a treemap.\n- an embedding script to integrate the viewer into an existing webpage.\n\n⚠️ Please note that this is a research prototype and not meant for use in production as of now.\n\n# Integration into your Github project\nCreate a new GitHub Actions workflow in your project, e.g. at `.github/workflows/analytics-embedding.yml`. The content of the file should be in the following format:\n```yaml\nname: Analytics Treemap Embedding\n\non:\n  # Trigger the workflow on push or pull request,\n  # but only for the main branch\n  push:\n    branches:\n      - main\n      \n  pull_request:\n    branches:\n      - main\n\njobs:\n  analytics-embedding:\n    name: Run Analytics Treemap Embedding 🔎\n    runs-on: ubuntu-latest\n    permissions: write-all\n\n    steps:\n      - name: Check out Git repository\n        uses: actions/checkout@v4\n\n      - name: Run Analytics Treemap Embedding Action 🚀\n        uses: hpicgs/github-software-analytics-embedding@v0\n        with:\n          # Optional, use if you want to analyse a specific folder\n          repository_path: ./\n          # Optional to enable benchmarking\n          benchmark: true\n```\n## Development\n\nInstall `pnpm`:\n\n```\nnpm i pnpm -g\n```\n\n### Setup Frontend Development\nTo setup the Frontend for development run:\n\n```\ncd frontend\npnpm i\npnpm run dev\n```\n\nNavigate to `localhost:3000` in the browser of your choice.\n\n### Setup Code Anayltics Development locally\nCreate an .env file\n```\ncd analytics\ncp .env.example .env\n```\nMake shure you fill in the GITHUB_TOKEN variable in the `.env` file\n\nTo setup the node application for code analysis for development run:\n```\ncd analytics\npnpm i\npnpm start\n```\n\n### Git blobs gh api\nThis repo uses the github git database API to store commit based software analytics data on a custom ref directly in the repository. This means the meta data will not be cloned if you run git pull normally.\n\n## Building and running the docker container locally\n```\ndocker build -t analytics . \u0026\u0026 docker run -it analytics\n```\n## Testing Pipelines Locally\nhttps://github.com/nektos/act\n```\ngh extensions exec act\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpicgs%2Fgithub-software-analytics-embedding","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhpicgs%2Fgithub-software-analytics-embedding","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpicgs%2Fgithub-software-analytics-embedding/lists"}