Preflib-Django

This repository contains the Django project for the PrefLib.org website. It is meant to be used by people who know how Django works. If it is not your case and you want to learn more about Django, check the Django project page that has some quite nice tutorials.

Setting Up the Website

If you want to play around with the website, after cloning the repository, run the quick-setup script:

python3 quicksetup.py

This script creates all the required folders and files. Note that you might need to install additional python packages for the script to run through. After the script is done, we advice to add some data to the newly created website. To do so, first download some zipped datasets from PrefLib.org website. You can use the following links:

• AGH course selection: https://www.preflib.org/static/data/agh/agh.zip
• Aspen election data: https://www.preflib.org/static/data/aspen/aspen.zip

To add the dataset to the website, run the following commands:

python3 manage.py adddataset -f path/to/the/file/agh.zip
python3 manage.py adddataset -f path/to/the/file/aspen.zip

You are now almost done, just run two more scripts and you will have a fully functional website.

python3 manage.py updatemetadata --all
python3 manage.py generatezip

Note that these two last scripts can take long, especially if you have added a lot of data.