Code Monkey home page Code Monkey logo

hacktoberfest-checker's Introduction

Hacktoberfest Checker

Build Status GitHub

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/ (https://hacktoberfestchecker.herokuapp.com/ will still work)

Screenshot

2018!

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).

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.

Happy hacking!

Requirements

  • 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.

  • 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
  • $ yarn install

  • $ yarn start

  • Point browser to localhost:5000

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

License

MIT ยฉ 2015-2018 Ian Jenkins

"unable to clone project"

hacktoberfest-checker's People

Contributors

aj07 avatar andeersg avatar antzshrek avatar artemgrinn avatar butlerx avatar deneuv34 avatar dirtyf avatar emmanueldemey avatar equim-chan avatar fdocr avatar furikuri avatar games647 avatar giraugh avatar irregularshed avatar jenkoian avatar jvt avatar lex111 avatar matteo-hertel avatar mstruebing avatar myrridin avatar ne3l avatar petk avatar petrkle avatar rabinzon avatar rafaelstz avatar rdil avatar redice44 avatar shavidzet avatar tessus avatar thecreazy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.