https://github.com/federicoceratto/github-traffic-charts

Generate traffic charts from GitHub
https://github.com/federicoceratto/github-traffic-charts

charts daemon github nim nim-lang traffic

Last synced: 17 days ago
JSON representation

Generate traffic charts from GitHub

• Host: GitHub
• URL: https://github.com/federicoceratto/github-traffic-charts
• Owner: FedericoCeratto
• License: gpl-3.0
• Created: 2018-04-21T12:29:30.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-21T12:44:56.000Z (almost 7 years ago)
• Last Synced: 2024-12-28T04:15:49.975Z (26 days ago)
• Topics: charts, daemon, github, nim, nim-lang, traffic
• Language: Nim
• Size: 16.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        

=== GitHub traffic charts

image:https://img.shields.io/badge/status-alpha-orange.svg[badge]

image:https://img.shields.io/badge/version-0.1.0-orange.svg[badge]

image:https://img.shields.io/badge/License-GPL%20v3-blue.svg[License]

GitHub publishes project view and clone metrics only for the owner and with 14 days of history.

This daemon collect metrics for multiple users/orgs/projects and generates HTML charts every day.

It requires a GitHub "Personal access token" with "repo" scope.

==== System-wide installation

Install nim on Debian/Ubuntu with:

    sudo apt install nim

Build and install the package with:

    nimble build_deb

    sudo dpkg -i ../github-traffic-charts_*.deb

Configure /etc/github_traffic_charts.conf.json and restart the daemon

Find outputs in /var/lib/github_traffic_charts/output/

Monitor with:

    sudo journalctl -f -u github-traffic-charts

==== Local run

Build a binary with:

    nimble build

Configure ./github_traffic_charts.conf.json

Run:

    ./github-traffic-charts

==== Configuration

If the user:... or org:... blocks are left empty, the daemon will scan all existing projects.

Example:

[source,json]

----

{

  "format-version": 1,

  "charted-days": 14,

  "charted-weeks": 4,

  "max-repos-per-chart": 12,

  "token": "REPLACEME",

  "repos": {

    "user:REPLACEME": [

    ],

    "user:REPLACEME": [

    ],

    "org:REPLACEME": [

    ],

  }

}

----