/GitHub-Vis

Software Engineering Project that interrogates Github API for data visualisation.

Primary LanguageJavaScript

GitHub-Vis

This project was created for a third year Software Engineering module in TCD.

Full Demo

Project Description

This project was built using:

Login

login The login screen uses Octokit to authenticate the GitHub user using basic authentication. It handles incorrect username and password.

I could have made this project without user auth. However, the spec said a logged in user and it does allow us to pull some information about private repos as well other additional information.

Dashboard

dashboard The dashboard is the mains screen for this application. It displays the users basic information as well as presenting three cards for stats.

  • Quick Stats -> Basic stats like the number of followers, private/public repos, gists etc.
  • Language Stats -> shows the bytes of code written in each language across all repos. It displays this data in a pie chart.
  • Punch Card Stats -> Frequency of commits for week across all repositories. The size of the circle represents the number of commits in the hour.

Stars

stars This screen simply show the users stars and allows them to follow the link to the starred repo.

Usage

npm install

Install dependencies.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.