https://github.com/bessouat40/github-traffic-dashboard
https://github.com/bessouat40/github-traffic-dashboard
github github-profile traffic-analysis viewers
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bessouat40/github-traffic-dashboard
- Owner: Bessouat40
- Created: 2024-03-09T10:01:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T18:51:55.000Z (over 2 years ago)
- Last Synced: 2025-06-13T16:09:37.950Z (about 1 year ago)
- Topics: github, github-profile, traffic-analysis, viewers
- Language: JavaScript
- Homepage:
- Size: 1.53 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 :
```bash
TOKEN=... #your token value
```
## Usage
### Setup environment
First you need to setup your environment :
- Fill backend path in `.env.example` file :
```bash
LIBRARY=... #path to ./backend
```
- Change `.env.example` name to `.env` :
```bash
mv .env.example .env
```
### Run application
#### Run backend
```bash
python backend/utils/main.py
```
#### Run frontend
```bash
cd front
npm start
```