README.md

GantSign open-source project statistics

Project to collect and display information from GitHub and Ansible Galaxy to provide and overview of GantSign open-source projects.

Web interface

You can view the web interface at https://gantsign.com/stats.

Gathering data

Dependencies:

• Linux (e.g. Ubuntu Xenial)
• Python 3.10 (you can install this using https://github.com/pyenv/pyenv)

If you'd like to gather the data for yourself you need to run the following from the project root:

# Install pipenv
sudo pip install pipenv

# Install project dependencies
pipenv install

# Set your GitHub token (no additional permissions necessary)
export GH_TOKEN=<YOUR GITHUB TOKEN HERE>

# Run the report
pipenv run python report.py

Built using

• Python 3
• pandas
• Pipenv
• PyGithub
• tqdm
• Pylint
• YAPF
• Rope

To build the web application

Dependencies:

• Node.js 18 (you can install this using https://github.com/creationix/nvm)

To build the web interface run the following from the project root:

npm run build

You can also run a local development server using:

npm start

Built using

• TypeScript
• Node.js
• React
• Material-UI
• Axios
• SemVer
• Create React App
• TSLint

License

This software is licensed under the terms in the file named "LICENSE" in the root directory of this project. This project has dependencies that are under different licenses.

Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)