uclcomputerscience/103p_2018_team25

IXN Matching System Web Application

IXN Matching Application

Applied Software Development application by team 25. The purpose of the project is to match students and their interests to potential client projects. This file describes the setup required for a local development server, and should not be used to deploy to a server.

Development Setup

1. Clone this repository with: git clone [email protected]:UCLComputerScience/103P_2018_team25.git
2. Install prerequisites
3. Follow the MySQL database setup
4. Follow the environment variables setup
5. Make the relevant migrations with: python3 manage.py makemigrations
6. Apply the relevant migrations with: python3 manage.py migrate
7. Collect static files with : python3 manage.py collectstatic
8. Run the Django server with: python3 manage.py runserver
9. Load the site at: 127.0.0.1:8000
10. Create a superuser to access admin page at 127.0.0.1:8000/admin

Prerequisites

Django 1.11.10
MySQL Server
mysqlclient 1.3.12 (Python module)
requests (Python module)
python-decouple (Python module)
django-tables2 (Python module)
tablib 0.11.4 (Python module)

MySQL Database Setup

NAME: matching_db (create an empty database)
USER: matching_db_user (create this user and grant all privileges)
PASSWORD: matching_db_password

Environment Variables

These variables will need to be placed in a .env file in the local repository

DEBUG=True
SECRET_KEY=(Generate a Django secret key)
DATABASE_NAME=matching_db
DATABASE_USER=matching_db_user
DATABASE_PASSWORD=matching_db_password
DATABASE_HOST=localhost
DATABASE_PORT=0
ALLOWED_HOSTS=.127.0.0.1
SECURE_SSL_REDIRECT=False
CSRF_COOKIE_SECURE=False
SESSION_COOKIE_SECURE=False
X_FRAME_OPTIONS=DENY
SECURE_BROWSER_XSS_FILTER=False
UCL_API_CLIENT_ID=(Sign up to UCL API for these)
UCL_API_CLIENT_SECRET=(Sign up to UCL API for these)

103p_2018_team25's Issues

Students can duplicate tags in form

Currently a student could choose a tag as their like and also their dislike, which will cause issues with the matching algorithm. Drop-down menus need to not include choices selected within the other drop down menus. Possibly solved by: https://simpleisbetterthancomplex.com/tutorial/2018/01/29/how-to-implement-dependent-or-chained-dropdown-list-with-django.html

Matching Algorithm Edge Cases

Need to check how the algorithm will react when too many or too few projects are supplied when matching with the students. Dean informed me it is okay to simply output any projects or students that have not been matched into another column of the output CSV. Also, what will happen if one of the tags a student has selected is not available in any of the projects.

No front end

Code for the front end needs to be pushed.

Custom Views Missing

The custom views to upload data will show at index/ but not at index/matchingsystem. May need to override other HTML forms.

Client cannot create more than 1 project

Causes an integrity error. Probably to do with the database models.

Project model needs a field for the date the project will need to be completed by

During the last demo this was mentioned by Dean, I think to help with the placement of which module.