# Github Insights
Get insights for your Github repositories
# Local usage
- Clone this repository
.envand add your Github Auth Token in the new
yarn fetchby 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
- Wait for the script to fetch and transform the data from Github.
- Check the
insights.jsonfile in the root of the project.
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.
This tool uses the 3rd version of the Github REST API (opens new window).
github-insights collects the following data for your user's or organisation's repositories:
# Support this project