https://github.com/scriptex/github-insights

Get insights for your Github repositories
https://github.com/scriptex/github-insights

github-api github-insights github-rest-v3

Last synced: 7 months ago
JSON representation

Get insights for your Github repositories

• Host: GitHub
• URL: https://github.com/scriptex/github-insights
• Owner: scriptex
• License: mit
• Created: 2020-06-03T08:34:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-01T06:47:16.000Z (8 months ago)
• Last Synced: 2025-04-10T04:05:14.455Z (7 months ago)
• Topics: github-api, github-insights, github-rest-v3
• Language: JavaScript
• Homepage: https://github-insights.atanas.info/
• Size: 5.39 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Github Build](https://github.com/scriptex/github-insights/workflows/Build/badge.svg)](https://github.com/scriptex/github-insights/actions?query=workflow%3ABuild)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/34d3d75710534dc6a38c3584a1dcd068)](https://www.codacy.com/gh/scriptex/github-insights/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/github-insights&utm_campaign=Badge_Grade)

[![Codebeat Badge](https://codebeat.co/badges/d765a4c8-2c0e-44f2-89c3-fa364fdc14e6)](https://codebeat.co/projects/github-com-scriptex-github-insights-master)

[![CodeFactor Badge](https://www.codefactor.io/repository/github/scriptex/github-insights/badge)](https://www.codefactor.io/repository/github/scriptex/github-insights)

[![DeepScan grade](https://deepscan.io/api/teams/3574/projects/5257/branches/40799/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)

[![Analytics](https://ga-beacon-361907.ew.r.appspot.com/UA-83446952-1/github.com/scriptex/github-insights/README.md?pixel)](https://github.com/scriptex/github-insights/)

# Github Insights

> Get insights for your Github repositories

[Start using the live application now](https://github-repository-insights.now.sh/)

## Visitor stats

![GitHub stars](https://img.shields.io/github/stars/scriptex/github-insights?style=social)

![GitHub forks](https://img.shields.io/github/forks/scriptex/github-insights?style=social)

![GitHub watchers](https://img.shields.io/github/watchers/scriptex/github-insights?style=social)

![GitHub followers](https://img.shields.io/github/followers/scriptex?style=social)

## Code stats

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/scriptex/github-insights)

![GitHub repo size](https://img.shields.io/github/repo-size/scriptex/github-insights?style=plastic)

![GitHub language count](https://img.shields.io/github/languages/count/scriptex/github-insights?style=plastic)

![GitHub top language](https://img.shields.io/github/languages/top/scriptex/github-insights?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/scriptex/github-insights?style=plastic)

## Local usage

1. Clone this repository

2. Run `npm install` or `yarn`

3. Copy `.env.example` to `.env` and add your Github Auth Token in the new `.env` file:

    ```sh

    TOKEN=your_github_token

    ```

4. Run `npm fetch` or `yarn fetch` by provding at least one of the required arguments:

    - `--org`: a Github organisation name

    - `--user`: a Github user name

    - `--repository`: a Github repository in the following format `:owner/:repository` (`scriptex/github-insights`)

5. Wait for the script to fetch and transform the data from Github.

6. Check the `insights.json` file in the root of the project.

## Frontend

There is a frontend application included built with Parcel and React using Recharts.

**The application is still a work in progress.**

The deployment is taken care of by Vercel.

If you want to experience the full capabilities of this package locally then you need to create your own Vercel account, install the `now cli` and run `now dev` after you linked your clone/fork with Vercel.

More on this later.

## About

This tool uses the 3rd version of the [Github REST API](https://developer.github.com/v3/).

`github-insights` collects the following data for your user's or organisation's repositories:

-   paths

-   views

-   forks

-   clones

-   commits

-   referrers

-   contributors

## LICENSE

MIT

---



    Connect with me:








    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    

     

    

        

    



---



Support and sponsor my work: