https://github.com/4nt0ineb/gitclout
https://github.com/4nt0ineb/gitclout
angular chartjs jgit spring-mvc tailwindcss
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/4nt0ineb/gitclout
- Owner: 4nt0ineB
- Created: 2025-03-12T18:21:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T18:22:27.000Z (about 1 year ago)
- Last Synced: 2025-06-08T12:03:45.495Z (11 months ago)
- Language: Java
- Size: 2.99 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SEBBAH-BASTOS
## The project
GitClout is a web app that analyzes a specified Git repository (e.g. github or gitlab) to offers insights into the contributions made by each contributor.
The back-end uses Java with Helidon 3 SE to serve a REST API and the static pages.
The front-end uses react and semantic.
### Run the app
```sh
java --enable-preview -jar GitClout-1.0.0.jar
```
At start, the address of the web main page will be printed out as well as the swagger page address of the OPEN API file, for example :
```shell
WEB server is up! http://localhost:8080
OPEN API http://localhost:8080/openapi/ui
```
#### Configuration
You can override some default properties with inline options at app start
| Name | Type | default |
|--------|---------|---------|
| --port | integer | 8080 |
| --concurrentAnalysis | integer | 2 |
| --analysisThreadPoolSize | integer | 3 |
A .gitclout-data/ directory, containing the app’s data, cloned repositories and database, is created at the current working directory where the app has been launched.
### Programming language support
As of today GitClout app v1.0.0 supports these programming languages,
and other types of contributions in a given git repository:
| Category | Type |
|----------|---------------------------------------------------------------------------------------------------------------|
| CODE | c, java, html, css, python, ruby,
javascript, typescript, ocaml, php, jasm |
| CONFIG | git, yaml, |
| DOC | markdown, documentation in code (javadoc, docstring, etc.. any extracted doc in code file is undistinguished) |
| BUILD | makefile, maven, gradle |
### Credits
Many thanks to Dominik Stadler's jgit-cookbook repository and Rüdiger Herrmann for his post on Diffs with JGit
that allowed us to better understand and deal with the JGit API.
https://github.com/centic9/jgit-cookbook
https://www.codeaffine.com/2016/06/16/jgit-diff/