Team Software Project

Team Members

Colin Kelleher - 117303363
Liam de la Cour - 117317853
Karol Przestrzelski - 117360873
Jonathan Hanley - 1174743096
Peter O'Donoghue - 117326743
Colum O'Donovan - 117363271

Programming Langagues

Python Programming Language
JavaScript
Bash
CSS
HTML

Installation

git clone https://github.com/colinkelleher/TeamSoftwareProject.git
cd TeamSoftwareProject
pip3 install --user -r requirements.txt

Running

python3 app.py

Running

Open localhost:8080/index.py

Coding Requirements

All code will be commented to ensure everyone on the team can understand what is happening and ensure maintainability

HTML Comments
<!--All HTML comments should be written in this format, above the code you wish to comment -->

Python Comments

    Within Functions
        """
        :param other: password to compare
        :return: True if password matches the clear text
                  False if the do not match
        """
        
   At the beginning of the file
        """
        TeamSoftwareProject (CK, JH, PO'D, CO'D, LdlC, KP)
    
        Description of what the file / python program does
    
        Within this file we have (list the functions within the file)
        - Constructor for class: __init__
        - what function1 does: name of function1
        - what function2 does: name of function2
        - what function3 does: name of function3
        """
        
  Additional single line comments
        # this is an example of a simple line comment

Due Dates

#3