GitHub Views

⭐ Features

• Login With GitHub
• View all time views and unique views charts for your repos
• Share your repos views data with other users
• Create aggregate line-charts of multiple repos
• Email & Password authentication
• Export data as CSV
• Configurable time window for charts
• Display commits as vertical markers (lines) on the repo chart
• Cumulative charts summing the views of multiple repos into one line chart
• Create aggregate bar-charts of multiple repos

🚀 Deployment

Clone this repository.

$ git clone https://github.com/MicrochipTech/GitHub-Views.git

In the project folder create a file called .env. This file is used to configure the variables used by Docker. There is an example file called .example.env in this repo.

The complete list of variables that have to be in your .env file is:

• MONGO_USERNAME
• MONGO_PASSWORD
• MONGO_DATABASE
• ME_CONFIG_BASICAUTH_USERNAME
• ME_CONFIG_BASICAUTH_PASSWORD
• GH_CLIENT_ID
• GH_CLIENT_SECRET
• TOKEN_ENC_KEY
• TOKEN_SIG_KEY

MONGO_USERNAME, MONGO_PASSWORD, MONGO_DATABASE, ME_CONFIG_BASICAUTH_USERNAME, ME_CONFIG_BASICAUTH_PASSWORD values you can chose freely.

Now create a new GitHub OAuth application. You will need the client id and the client secret associated with this GitHub OAuth application. These will be added in the .env file as the values of GH_CLIENT_ID and GH_CLIENT_SECRET.

TOKEN_ENC_KEY and TOKEN_SIG_KEY keys are used to protect the GitHub access tokens once saved in the database. Use the following commands to generate them:

$ openssl rand -base64 32
$ openssl rand -base64 64

Install the npm dependencies and start the application.

$ cd src
$ npm i
$ cd ..
$ docker-compose up

Visit http://loclahost:8000 and login with your GitHub account.

The tool will start collecting views data for all the repos you have access to.

👍 Your contribution is awesome

Feel free to add features and this project and submit a PR. We will add you to the contributors list below.