https://github.com/hpicgs/github-software-analytics-embedding
Seminar Project of the Seminar "Advanced Techniques for Analysis and Visualization of Software Data" of CGS, HPI and DEF in the Summer Term 2022
https://github.com/hpicgs/github-software-analytics-embedding
code-analysis data-visualization github-actions typescript
Last synced: 6 months ago
JSON representation
Seminar Project of the Seminar "Advanced Techniques for Analysis and Visualization of Software Data" of CGS, HPI and DEF in the Summer Term 2022
- Host: GitHub
- URL: https://github.com/hpicgs/github-software-analytics-embedding
- Owner: hpicgs
- License: mit
- Created: 2022-05-05T13:17:08.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-12-10T19:59:48.000Z (about 1 year ago)
- Last Synced: 2025-07-16T21:06:46.136Z (6 months ago)
- Topics: code-analysis, data-visualization, github-actions, typescript
- Language: JavaScript
- Homepage: https://hpicgs.github.io/github-software-analytics-embedding
- Size: 7.71 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# github-software-analytics-embedding
Seminar Project of the Seminar "Advanced Techniques for Analysis and Visualization of Software Data" of CGS, HPI and DEF in the Summer Term 2022
This project contains:
- 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`.
- a React frontend to visualize the calculated metrics in a treemap.
- an embedding script to integrate the viewer into an existing webpage.
⚠️ Please note that this is a research prototype and not meant for use in production as of now.
# Integration into your Github project
Create 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:
```yaml
name: Analytics Treemap Embedding
on:
# Trigger the workflow on push or pull request,
# but only for the main branch
push:
branches:
- main
pull_request:
branches:
- main
jobs:
analytics-embedding:
name: Run Analytics Treemap Embedding 🔎
runs-on: ubuntu-latest
permissions: write-all
steps:
- name: Check out Git repository
uses: actions/checkout@v4
- name: Run Analytics Treemap Embedding Action 🚀
uses: hpicgs/github-software-analytics-embedding@v0
with:
# Optional, use if you want to analyse a specific folder
repository_path: ./
# Optional to enable benchmarking
benchmark: true
```
## Development
Install `pnpm`:
```
npm i pnpm -g
```
### Setup Frontend Development
To setup the Frontend for development run:
```
cd frontend
pnpm i
pnpm run dev
```
Navigate to `localhost:3000` in the browser of your choice.
### Setup Code Anayltics Development locally
Create an .env file
```
cd analytics
cp .env.example .env
```
Make shure you fill in the GITHUB_TOKEN variable in the `.env` file
To setup the node application for code analysis for development run:
```
cd analytics
pnpm i
pnpm start
```
### Git blobs gh api
This 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.
## Building and running the docker container locally
```
docker build -t analytics . && docker run -it analytics
```
## Testing Pipelines Locally
https://github.com/nektos/act
```
gh extensions exec act
```