hacktoberfest-leaderboard

This is the leaderboard application for the Hacktoberfest summit. The application is kept simple so you can improve it with your own pull requests to help you contribute for Hacktoberfest.

The application is hosted on Heroku. Visit it here

Happy coding!

How to test & run locally

The application is written in Ruby, using the Sinatra framework.

Need to learn Ruby ? Visit Rubymonk

Setup dev environment

First, you need to install a ruby interpreter, alongside with the gem ruby package management tool. Visit Ruby language website for more details.

JRuby is also supported. It's a popular ruby interpretter written in pure java.

You'll probably need an editor too. Notepad++ is a simple alternative, Visual Studio Code is a more advanced one.

If you're running behind a proxy, you'll need to set both environment variables HTTP_PROXY and HTTPS_PROXY before going further

Download and install bundler by running

    gem install bundler

Then, go to the project directory and run

    bundle install

Running tests

In order to run unit tests, run

    bundle exec rake

If you're running behind a proxy, you'll need to set both environment variables HTTP_PROXY and HTTPS_PROXY

Configuring the app

Configuration is exclusively done by setting environment variables:

• PORT : The port to bind HTTP to. Default to 80
• RACK_ENV : Should be set to production. Automatically set when deploying to Heroku.
• GH_TOKEN : The token to authenticated to github. By default, no token is used, so API calls are not authenticated.
• EVENT_DATE : The date to restrict contribution search to. It must follows the github search date format (more details here). Default value is >=2005 which basically fetch everything without any restriction
• PARTICIPANTS_FILE : The URI or file path to the file containing the participants' github usernames. See this file for an example of how to format that file
• OBJECTIVE : Number of pull requests to make in order to complete the challenge. Default value is 5

Again, if the app running behind a proxy, you'll need to set both environment variables HTTP_PROXY and HTTPS_PROXY before running it

Running the app

Then start the application by running

    bundle exec rake run

then browse to http://localhost

Useful documents

• Sinatra usage (Web microframework)
• Octokit usage (github api library)
• Spectre CSS