COMP3900 Project - Property Rental System

Peter Nguyen z5019537

Michael Thanh Tran z5062007

Tutorial Time: Tuesday 11am - 1pm

Tutor: Ali Darejeh

Prerequisites: Python3, pip, pipenv

If installing on a Linux machine:

1. Python3 not installed? run: sudo apt-get install python3.6 in the terminal
2. pip not installed? run: sudo apt-get install python3-pip

If installing on a Windows machine:

1. Python3 not installed? Download at: "https://www.python.org/ftp/python/3.6.8/python-3.6.8-amd64.exe"
2. Upon starting installation, click checkbox "Add Path 3.6 to PATH" to run in Command Prompt
3. Open Command Prompt (Easiest through search bar) and run python --version, the output should be Python 3.6.8 if the installation was successful

The following steps apply for both Linux and Windows machines:

4. Install pipenv by running python -m pip install pipenv
5. Go to the root directory of the project folder. run cd .../.../capstone-project-216 (Linux) (The directory which contains requirements.txt)
   • Windows uses "\" instead of "/"
6. run: pip install -r requirements.txt
7. run: cd src
8. run: python manage.py makemigrations main and python manage.py makemigrations authentication
9. run: python manage.py migrate
10. run: python manage.py loaddata fixtures.json
11. run: python manage.py runserver [OPTION: --insecure]
    • NOTE: 404 pages will not be handled because debug mode is currently set to DEBUG=True, for the sake of displaying property images when uploaded. To see how 404 pages are handled debug mode needs to be off DEBUG=False and ran with --insecure in the command. Staticfiles will not be served when DEBUG = False, since production web server takes care of these files. --insecure mode allows to access staticfiles files during development. Follow the note below to help change DEBUG mode
12. Copy url given in the terminal and paste it in browser to open web application
    • e.g. http://127.0.0.1:8000/ or something like that

Note: Database will be empty and registering accounts and listing property is needed to populate searched results, property listing and list of bookings. If the layout is plain or no images are displayed when uploaded due to DEBUG = False, cd src and within settings.py, change DEBUG=FALSE into DEBUG = TRUE. It is currently set to off to handle 404 pages.