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.
Installation
- Make sure you've installed node. If not download and install it from here
- Clone the repository:
git@github.com:hpi-epic/repositoryguide.gitand go into the repository folder - Run
npm installin the root of the repository - Run
npm startto compile the scss and start a server - Open the home page in a browser (default address is
localhost:3000/views/home)
Configuration
- Generate a personal access token for GitHub using these instructions
- On the settings page, download the config to have an empty version of a
config.json file. Replace"github_access_token": ""with"github_access_token": "<your token>" - Load the edited config into the application.
Codestyle
To define a codestyle, we used Prettier and Eslint. Use npm run prettier-<check|autofix> or npm run eslint-<check|autofix> to apply these rules.
Alternatively, you can set these up for your IDE. For Webstorm follow the following tutorials:
- ESLint
- Follow the following steps from this tutorial
- Prettier
- Follow the following steps from this tutorial