The Hubcare is an open-source project intended to help free software users and potential contributors to decide which repositories they should use or on which they should contribute. It has an API that pulls data from GitHub API and post it to a Add-on. Any more details about project may be found on Documentation, which is mostly in Portuguese, due to Brazilian project stakeholders.
This repository, in special, is fully dedicated to the maintain API details. Feel free to read, run and contribute.
Just go to HubCare's page on Chrome Store and be happy 😉
Wanna see it working on your machine, uh?
Unfortunately, the Add-on code wasn't made for local interaction, you may want to up the API on some deploy service to see it working. But you can still run the API and the Add-On separately if you want.
You'll need have Docker and Docker-Compose installed to see the magic happenning.
And I just know how to do it on a Linux machine. C'mon, Windows is just for gaming, y'know. And MacOS users surely can pay someone to discover how to do it.
Downloading
cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.1-hubcare-api.git
cd 2019.1-hubcare-apiThe HubCare API need to send a GitHub username and an API token to authenticate on GitHub API. This is set by environment variables as shown below. You can generate tokens here.
export NAME='username'
export TOKEN='token'There you go!
docker-compose build
docker-compose upIf everything was done right, you now have the HubCare running on your machine. Just navigate to 0.0.0.0:8000 and you should see something. There are services running on ports [8000..8003].
Test it on http://0.0.0.0:8000/hubcare_indicators/fga-eps-mds/2019.1-hubcare-api
Obs: If you ever need to change the values of NAME or TOKEN, rerun docker-compose build. Those variables are got in build time.
Downloading
cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.1-hubcare-plugin.git
cd 2019.1-hubcare-pluginBuilding and uping things:
docker-compose build
docker-compose upThis should be enough to turn the service on ( ͡° ͜ʖ ͡°).
Then, open Google Chrome on chrome://extensions/, activate Developer mode on top right corner.
You now shoud see hubcare extension, just activate it.
Just go to some GitHub repo to see it working. I recommend this one, you can even give it a star! 😉
Okay, I undertand, you don't believe on internet info, wanna see it on your own machine, right?
There you go then
cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.1-hubcare-docs.git
cd 2019.1-hubcare-docsYeah, now run the docs, girl! Run the docs, boy!
docker-compose up --buildNow, localhost:8000 should have a beautyful documentation page.
Obs: If you ever want to contribute to docs, make sure to check if the MKDocs is rendering as you wish with the proceed above.
It's set on GitLab, so we can use GitLab CI.
Please make sure to read the Contributing Guide before making a pull request. After you've read, don't forget to take an issue!
To execute all tests:
make testTo get a Coveralls report:
make coveragemake styleDo whatever you want with this code, bro/sis. This is under MIT License.