Github Traffic Dashboard

This project aims to display traffic on your personal projects.

Setup

First you need to create a key for Github API :

• Go to your Github Page / Settings / Developer settings

• Click on Token (classic)

• Click on Generate new token / Generate new token (not classic)
• Set Repository access value to All repositories
• For Permissions, you need at least to set Administration to Read and write

Now, you'll have a token value, copy this value to your clipboard and paste this value inside your .env.example file :

TOKEN=... #your token value

Usage

Setup environment

First you need to setup your environment :

• Fill backend path in .env.example file :

LIBRARY=... #path to ./backend

• Change .env.example name to .env :

mv .env.example .env

Run application

Run backend

python backend/utils/main.py

Run frontend

cd front
npm start