Get Set FOSS Leaderboard

Official leaderboard for Get Set FOSS.

Setup

1. Clone the repository:

   $ git clone https://github.com/axios-iiitl/Get-Set-Foss-Leaderboard.git
   

2. Change the directory, create a virtual environment, activate it and install all dependencies:

   $ cd Get-Set-Foss-Leaderboard/
   $ virtualenv venv --python=python3.7
   $ source venv/bin/activate
   $ pip install -r requirements.txt

3. Change the directory and run the makemigrations and migrate command:

   $ cd source/
   $ python manage.py makemigrations
   $ python manage.py migrate

4. Create a super user:

   $ python manage.py createsuperuser

5. Collect all static files:

   $ python manage.py collectstatic
   

6. Run the server:

   $ python manage.py runserver

Automating The Leaderboard

1. Add your GitHub Personal Access Token in settings.py. Edit the GITHUB_PERSONAL_ACCESS_TOKEN setting and insert your token there. You can read more about creating your own personal access token here: https://git.io/JeuQ3.

2. Add participating repositories from the admin panel.

3. Every participant must sign in with GitHub.

4. Only merged PRs will result into points.

5. Each merged PR must have two labels so that it gets counted:

   • getsetfoss2019: Every PR must have this label so that it gets recognized as a valid PR for the event. If the PR doesn't have this label, it will get ignored and no points will be rewarded.

     • To change this to some other label, edit the MAIN_LABEL setting in settings.py.

   • Every PR must have a label which corresponds to its points. Valid labels are: extra (5 points), very easy (10 points), easy (15 points), medium (25 points), hard (30 points), pro (50 points) and codeburst (100 points).

     • To add/remove any label, edit the POINTS_DATA setting in settings.py.

     • Always run these two commands after editing POINTS_DATA:

       $ python manage.py makemigrations
       $ python manage.py migrate

6. To sync the latest data, run sync_data command:

   $ python manage.py sync_data