republique-et-canton-de-geneve / github-traffic-statistics

HTML page to plot the number of viewers and cloners on État de Genève's GitHub projects.

This repository is small HTML/JavaScript page which gives graphical charts of the traffic ("unique cloners" and "unique visitors") on État de Genève's GitHub repositories.

Reference : GitHub traffic.

Technical facts

The application consists of three parts:

• A small HTML file
• A JavaScript file data/charts-data.js which stores the traffic values, for a set of GitHub repositories
• Two JavaScript files app/main.js and app/charts.js which plot the traffic values.

The application is based on the D3 library. It heavily borrows from Tutorial Point's primer.

Usage

In order to view the charts, simply open a browser on file charts.html. You don't need to have a Web server.

Customization

In order to accommodate this repository to your own GitHub page:

1. Clone this repository.

2. Edit file charts-data.js and replace the values with the traffic values of your own GitHub repositories.

3. Edit file main.js and replace the values with those of your own repositories. In the calls to function plot, beware of the 3rd parameter maxY: if it is smaller than the largest value, the repository's data won't be plotted at all.

On the community version of GitHub, the traffic values of your repositories are to be found at tab Insights, option Traffic. Note that GitHub provides values on a 2-week time range only. This implies that you have to pick and store these values quite regularly, e.g., every month; as far as we know, data older than two weeks are permanently lost.