The Metrics Dashboard webpage shows a weekly and monthly overview across open source projects within a specified organization. This webpage is meant to be used by developers and program managers interested in strategy and web presence within CMS open source projects
To collect metrics, first make sure you have set the following environment variables: - GITHUB_TOKEN - The github api key that you are using to collect data - AUGUR_HOST - The api domain corresponding to an instance of CHAOSS/Augur
Then, install the dependencies in requirements.txt.
Once the env is set up, either run the 'update data' GitHub Action in .github/workflows/update_data.yml or execute the update.sh shell script.
To run the server, make sure that your computer has npm installed.
Once npm is installed run npm install and npm start in the app/ directory.
A metrics web page that automatically pulls github repo data each week to produce numerical and visual statistics to aid developers and PMs in monitoring project health.
-
Clone the repo
git clone https://github.com/DSACMS/metrics.git -
Install the required packages in requirements.txt (preferably in a virtual env)
pip3 install -r requirements.txt -
Install node dependencies
cd app && npm install && cd ..
Thank you for considering contributing to an Open Source project of the US Government! For more information about our contribution guidelines, see CONTRIBUTING.md
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see SECURITY.md.
For more information about our Authors and maintainers, see MAINTAINERS.md. A full list of contributors can be found on https://github.cms.gov/$USERNAME/$REPONAME/graphs/contributors.
This project is licensed within in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.