Useful checker web app to see how close you are to achieving the requirements for a free t-shirt as part of Hacktoberfest.
I had some grand plans for this years edition but unfortunately I've not had the time. It basically equates to using
React on the front end. I did make a start, and may look to release it midway through Hacktoberfest. If you fancy hacking
along with me, keep an eye on the react branch. Other than that, I've done a simple reskin and more or less
kept it as it were last year (obviously updated the year and new PR requirement).
With massive thanks to Rafael Klaessen the react version is now merged and live!
I will add some tickets when I think of them of improvements etc. feel free to suggest any you can think of though too.
You may notice the domain has changed, the old heroku app is still up and I will deploy to both, but the new domain is hosted on digital ocean as they were kind enough to offer me some hosting vouchers.
- Node v8+
Recommended to use NVM
Running the app
Generate a GitHub personal access token to ensure you don't get rate limited as often.
.env.exampleas an example. Or export the GitHub token as an environment variable for Node.js to use:
- Windows (cmd.exe):
set GITHUB_TOKEN=YOUR TOKEN
- Windows (PowerShell):
$ yarn install
$ yarn start
Point browser to localhost:5000
Want to run the API server and the frontend in their own processes? Use this:
$ yarn start-frontend $ yarn start-server
Running the app within Docker
As an alternative to the section above, you can run the app within a Docker container:
$ docker build -t hacktoberfest-checker .
$ docker run -p 5000:5000 -e "GITHUB_TOKEN=YOUR_TOKEN" hacktoberfest-checker
or use the docker-compose
$ docker-compose up --build
MIT © 2015-2018 Ian Jenkins