How does it work?

The main goal of this project is to provide a front-end for every huskyCI user to check the stats of the analyses done. If you don't know yet what huskyCI is, check it out here.

Requirements

Node

If you don't have Node installed in your environment, follow the instructions here for your correspondent OS.

Yarn

npm install -g yarn

Installing

After cloning this repository, simply run these commands inside huskyCI-dashboard's folder:

make install
echo 'export REACT_APP_HUSKYCI_FE_API_ADDRESS="http://127.0.0.1:8888"' > .env
echo 'SKIP_PREFLIGHT_CHECK=true' >> .env
source .env

Running

After installing, an .env file with instructions to huskyCI-dashboard should be generated:

make run

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process of submitting pull requests to huskyCI-dashboard.

License

This project is licensed under the BSD 3-Clause "New" or "Revised" License - read LICENSE.md file for details.