README.md

Downing College JCR Room Balloting System

This system manages the allocation of college rooms during ballot weekend. It comprises a web application, which allows a student to view and select their room, and calculates room pricing automatically according to the Room Pricing Policy 2019.

Installation

Change into the desired installation directory then clone this repository:

$ git clone https://github.com/dowjcr/rooms

In line with best practice, create yourself a Python 3.5 virtualenv. Assuming you don't have virtualenv installed:

$ pip3 install virtualenv
$ mkdir virtualenvs
$ cd virtualenvs
$ virtualenv -p /usr/bin/python3 rooms
$ source rooms/bin/activate

Now you've activated the virtualenv, you can install the requirements:

$ cd ../rooms/rooms
$ pip install -r requirements.txt

Now configure Django's settings.py. An example configuration, settings_example.py has been included in the repo. Simply rename and edit as per the TODOs.

$ cd rooms
$ mv settings_example.py settings.py

Migrate and seed the database, then you're ready to run the test server:

$ cd ..
$ python manage.py makemigrations
$ python manage.py migrate
$ python manage.py seed
$ python manage.py runserver

Instructions on how to serve Django in production are widely available; mod_wsgi on Apache is to be recommended.

Built With

• Django
• django-ucamwebauth
• jQuery
• Bootstrap 4.1.1
• Lookup API

Contributors

• Cameron O'Connor, JCR Internet Officer 2018-19
• Lawrence Brown, JCR Internet Officer 2020-21

Licence

This project is licensed under the MIT Licence - see LICENSE.md for more details.