Skip to content

hubcare/docs

Repository files navigation

Hubcare - Documentation

All Contributors

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.

This repository, in special, is only to containing project Documentation, which is mostly in Portuguese, due to Brazilian project stakeholders.

For now, the only supported browser is Google Chrome, but NPM may build the Add-on for another browser.

Technologies

DjangoRestChromeVscodeDockerGithub

Installation

Installing from Chrome Store

Just go to HubCare's page on Chrome Store and be happy 😉

Running things locally

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.

Running the API

Downloading

cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.1-hubcare-api.git
cd 2019.1-hubcare-api

The 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 up

If 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

Running the Add-on

Downloading

cd ~/your/directory/
git clone https://github.com/fga-eps-mds/2019.1-hubcare-plugin.git
cd 2019.1-hubcare-plugin

Building and uping things:

docker-compose build
docker-compose up

This should be enough to turn the service on ( ͡° ͜ʖ ͡°).

Then, open Google Chrome on chrome://extensions/, activate Developer mode on top right corner.

Developer Mode

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! 😉

Running the... Docs?

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-docs

Yeah, now run the docs, girl! Run the docs, boy!

docker-compose up --build

Now, 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.

Deployment

It's set on GitLab, so we can use GitLab CI.

Built With

MKDocs - Material

Contributing

Please make sure to read the Contribution Guide before making a pull request. After you've read, don't forget to take an issue!

License

Do whatever you want with this code, bro/sis. This is under MIT License.

Contributors

Thanks goes to these wonderful people (emoji key):

Cleber Júnior
Cleber Júnior

📖 💻
Brian Lui
Brian Lui

💻
Lucas Hiroshi Horinouchi
Lucas Hiroshi Horinouchi

💻 📖
Rômulo Vinícius de Souza
Rômulo Vinícius de Souza

💻
Francisco Heronildo
Francisco Heronildo

💻
VitorMeirelesOliveira
VitorMeirelesOliveira

💻
Filipe Toyoshima
Filipe Toyoshima

📖
Vitor Alves
Vitor Alves

💻
Jacó Apolinário
Jacó Apolinário

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Dev's Recommendation to listen while Coding

SO MUSICAO

About

Documentation repository for the HubCare project

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published