Useful checker web app to see how close you are to achieving the requirements for a free t-shirt as part of Hacktoberfest.

https://hacktoberfestchecker.jenko.me/

Been really short on time this year, so just a quick reskin rather than any major tech advancements.

I will add some issues when I get chance of ideas that can be contributed, I'll continue to do this throughout the month.

Finally, I have to give a big shout out to DigitalOcean and Dev for yet another awesome event and their support for this checker app.

They do! However, I still think it's worth having a checker that doesn't require auth and allows you to check on your mates (or celebrity developers!).

Happy hacking!

• Node v10+

Recommended to use NVM

• Generate a GitHub personal access token to ensure you don't get rate limited as often.

• Create a .env file using .env.example as an example. Or export the GitHub token as an environment variable for Node.js to use:

  • Mac/Linux: export GITHUB_TOKEN=YOUR_TOKEN
  • Windows (cmd.exe): set GITHUB_TOKEN=YOUR TOKEN
  • Windows (PowerShell): $env: GITHUB_TOKEN=YOUR TOKEN

• $ npm install

• $ npm run tailwind-gen

• $ npm start

• Point browser to localhost:5000

Want to run the API server and the frontend in their processes? Use this:

$ npm run start-frontend
$ npm run start-server

or in a single command...

$ npm run start-development

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

Styling is done through tailwind as much as possible no CSS should be added and class names favoured. However, there will be occasions where custom CSS is required, in this case you need to edit style.css and run npm run tailwind-gen to generate the new CSS file.

Note: You should never directly edit index.css

MIT © 2015-2020 Ian Jenkins