Find the deployed software here: http://msci342-teammate.herokuapp.com/
WARNING: It is highly recommended to run the application locally if sensitive student data is being uploaded. Refer to the Setup the Development Environment section for instructions.
The application temporarily stores data in both your browser session storage and server memory. Personal identifiable information (first name, last name, user id) of the data is only used locally for display purposes, and does not get sent to the server. The model receives the data as student 1, 2, ... , n and returns the team assignments of student 1, 2, ... , n, which is then attached to the corresponding students data.
In addition, every instance of the model is protected using a client session-specific key, assigned when the model is started, which prevents any requests to the server from accessing a model that did not originate from the client session that initiated the model.
To deploy the application on Heroku, follow these steps:
- Create a new Heroku application
- Under the Settings tab, add Python as the buildpack under Buildpacks
- Under the Deploy tab, select master as our branch to deploy, then deploy the branch
To setup a development environment, follow these steps:
- Clone the GitHub repository to your local device
- Ensure your computer has Python 3 installed
- Install the Python packages listed in the
requirements.txtfile located in the root folder of the project - Using the terminal, open the root folder of the project
- Run the command
flask runto launch Flask on a local port - Open the local host address in a browser to view the deployed application
- Open the deployed Heroku app or the local development environment
- Access the Student Data file provided by Team 7 or download a sample Student Data file using the 'Download Sample File' button
- Click on the 'Upload Student Data' button and upload the Student Data file ensuring that the file is in .CSV format and has the correct header columns. If the uploaded file is not in an acceptable format, error messages will appear to assist
- Upon an upload of the correct Student Data file, click the 'Next Step' button in the bottom right hand corner
- Ensure that the number of students found in the inputted file is correct
- Enter the preferred team size. The system will not accept negative integers, floats, or numbers larger than the total number of students found
- After entering an accepted team size, click the 'Next Step' button
- Select the GPA checkbox if you want to distribute students based on their GPA, otherwise only student conflicts will be taken into account
- Click the 'Next Step' button
- Access the Conflict Data file provided by Team 7 or download a sample Conflict Data file using the 'Download Sample File' button
- Click on the 'Upload Conflict Data' button and upload the Conflict Data file ensuring that the file is in .CSV format and has the correct header columns. If the uploaded file is not in an acceptable format, error messages will appear to assist
- Upon an upload of the correct Conflict Data file, click the 'Generate Teams' button in the bottom right hand corner
- On the Teams page, view the generated teams based on the uploaded files and team size specifications
- If you wish to move a member of a team, click on the move button next to the students name and specify which team to move them to in the displayed drop down
- The personal conflicts and the GPA issues within each team will be populated in the issue boxes. These will be updated after moving each member (A GPA issue occurs when a team does not have any of the top n students or any of the bottom n students, where n is the number of teams).
- Click submit to move the student
- When ready to export the generated teams, click the 'Export Teams' button where a file names 'teams.csv' will download to your computer
- Click the 'Return to Start' button to return to the start of teammate