Insights

Visualize your coding journey!

About

Important

This project is not associated with or endorsed by GitHub.

A fun, interactive web application to visualize your activity on GitHub.

Features

• Commits
  • See how many commits you have made each month or year
• Issues and pull requests
  • See how many issues and pull requests you have opened or closed so far
• Top programming languages
  • See what are your most used programming, scripting or markup languages
• Topics
  • See which topics are most common across all your repositories

Installation

Prerequisites

You should have the following software installed. The application has been developed and tested with these versions but more recent and some older versions should be fine as well. If you run into any issues, try updating to a newer version.

• git: 2.25.1
• node: v20.10.0
• npm: 10.2.3

You can check which version you have installed from the command line by typing the name of the command followed by the --version flag.

It is also recommended to use Linux as everything has been tested only on a Linux distro. To use other operating systems, you may have to do some research of your own.

Download

Start by getting the source code by cloning the repository from the command line. Alternatively, you may download the source code as a zip archive or use other methods.

git clone [email protected]:rikurauhala/insights.git

Install

Next, make sure you are in the correct folder and install dependencies. The application will not work without installing dependencies first!

cd insights && npm install

Configure

Warning

Do not commit or share your personal access token, it should remain private.

To use the application, you must use your own personal access token. The application will not work without it as the token is used to authenticate with the GitHub API and fetch all the data used by the application.

You can create a new personal access token in the settings of your GitHub account.

1. Click the Generate new token button and choose classic
2. Choose a name and expiration time for the token
3. Select the scopes repo (everything) and read:user
4. Copy your token

Paste your token in a file named .env at the root of the project directory. Your token should be the value of the variable VITE_TOKEN.

echo 'VITE_TOKEN=your-token' >> .env

The file should look like this

# File: .env

VITE_TOKEN='your-token'

Run

To start the application in your browser, run the dev command. By default the application should be available at http://localhost:5173. Run npm run dev -- --host to access the application from your network with another device.

npm run dev

Documentation

• Architecture
• Credits
• License