search

hpi-epic / repositoryguide

Guiding you in exploring your team's Git(Hub) repository
MIT License
1 stars 1 forks source link

readme

RepositoryGuide

https://repositorygui.de/

The RepositoryGuide application aims at helping development teams gain insights into their teamwork based on the produced GitHub project data.

RepositoryGuide uses the public Github API to extract a set of key team measures for a GitHub repository. We envision the produced visualizations to be helpful in Retrospective meetings, where teams can analyze and interpret their projet data of an iteration. The focus of the included visualizations is on facilitating discussions in teams that can lead to collaborative software process improvement.

To set up a configuration for your team open the settings tab and follow the instructions there. Then you can edit your teams (stored in your own config), select your team and view the visualizations.

Executing the tool on your own machine

  1. Clone the repository: git@github.com:hpi-epic/repositoryguide.git and go into the repository folder
  2. Make sure you've installed node. If not download and install it from here
  3. Run npm install in the root of the repository
  4. Generate a personal access token for GitHub using these instructions
  5. Host the project on a local server, opening index.html directly won't work. The WebStorm IDE offers a local development server, or run one using python3 -m http.server.
  6. Download the config to have an empty version of a config.json file. Replace "github_access_token": "" with "github_access_token": "<your token>"
  7. Load the edited config into the application.
  8. The preparations are now done. Enjoy your metrics. :-)

Codestyle

To follow the codestyle used in this repository you need Prettier and Eslint. After having setup the project you need to setup these tools. For Webstorm follow the following tutorials: