Auguread Book Club System

Software Engineering Major Group Project consisting of club and book recommenders using KNN via. SurpriseLib’s machine learning scikit.

Team Sick Legends

The authors of the software are:

• Laurence Andrews
• Surya Brunton
• Giorgia Mocan
• Yasameen Mohammed
• Marc (Moishi Netzer) Netzer
• Iki (Niki) Norgren
• Aria Rub
• Clara Zard

Deployed version

Link (will be deployed by 15th April): https://auguread.herokuapp.com/

The deployed site can be accessed at: https://pure-bastion-32742.herokuapp.com/.

Access credentials

Example users will be provided by 15th April alongside the working deployed website.

Club Owner

• Email:
• Password:

Club Member

• Email:
• Password:

Club Applicant

• Email:
• Password:

Standard User

• Email:
• Password:

Installation instructions

To install the software and use it in your local development environment, you must first set up and activate a local development environment. From the root of the project:

$ virtualenv venv
$ source venv/bin/activate

Install all required packages:

$ pip3 install -r requirements.txt

Migrate the database:

$ python3 manage.py migrate

If an error like django.db.utils.OperationalError: table "{table_name}" already exists occurs, migrate using the command:

$ python manage.py migrate --fake clubs

Seed the development database with:

$ python3 manage.py seed

Run all tests with:

$ python3 manage.py test

Sources

The packages used by this application are specified in requirements.txt

• django-scheduler, specifically the Calendar, Event and Rule models

For more information, please refer to the Developer's Manual file.