Why

This repository is a try to get insights on an GitHub organization and its members.

Getting started

Install dependencies using yarn

yarn

How to use in command line

Create an .env file

GITHUB_ID=<github_id>
GITHUB_OAUTH=<oauth to access the API>
GITHUB_ORGA=<name of the organization>
GITHUB_WEBSITE=<repository name of the website>
GITHUB_WEBSITE_ORGA=<name of the website orga>

If you do not know how to get the GITHUB_OAUTH, please see this page. You have to create a token with the read:org access.

Usage

The following command allows you to get information on your organization. The generated files may be found in the data folder.

yarn start <organization_name>

The following command allows you to get insights from your organization's information.

yarn stats

You may also run the following command to generate a stats.json file containing the same insights:

yarn stats:file

You can add the organisazation name in the .env file. In this case use the key GITHUB_ORGA. If both choices are set the env variable will be taken.