Link Search Menu Expand Document

Assignment 9: Demo and Code Submission


Table of contents

Part 1: Demo Guidelines

  1. Sign up for a 15min slot on Zoom: sign up link.
  2. Start with a live demo of what you have built. Try to show in the best possible way what you have implemented and how. Go over what you consider to be the main highlighting features that will give us a good idea of the effort you have put into the project.
  3. Describe any unexpected or challenging aspects of the implementation process and how you overcame them.
  4. Be prepared to answer questions based on your live demo and project presentation. You may need to walk us through specific sections of your code.

Part 2: Code Submission

Upload all project code to Canvas using either a zip file or a link to your GitHub repository. If you are sharing a link, please make sure we have access.

Provide detailed instructions on how we can set up your project and execute your code in a seperated instruction document. We should be able to reproduce the demo following the instructions you provide in your Readme/Instructions file.

You might want to include the following information (ignore the ones that may not be applicable to your project):

Data Preparation and Setup

  1. Specify the database system(s) and version(s) used, along with installation instructions (a link to official documentation will be enough).
  2. Describe how to acquire project data. Include a small dataset sample (< 5 MB) or provide scripts to download/scrape/process the data.
  3. How do we load this data into the database system?
    1. Do you have some scripts to do that? If so, how do we execute them?
    2. Did you use some tools for loading? If so, provide appropriate details and links.
  4. If you are benchmarking different database systems, detail any configuration modifications made.
  5. If generating your own data, include a sample of the synthetic dataset/database.

Application and code

  1. List third-party libraries required for code execution and provide installation instructions (e.g., through a requirements.txt file).
  2. If applicable, explain how to run the GUI.
  3. Include any other relevant information about running your application.

Code Documentation and References

  1. Provide links to any code used from GitHub or other sources. Note that Using online code without appropriate citation/ credits would be considered plagiarism.
  2. If you referenced online code, explain any changes made to referenced code.
  3. Feel free to include images of your application’s working in Readme/Instructions file.

Part 3: Complete the Team Dynamics Assessment Form

Generally, teams work constructively together to complete projects. It’s important for us to know whether this is the case in your project. In the case of substantially imbalanced contribution, we will adjust participation grades to compensate.

So we can understand this, each member of the team needs to fill out the team feedback form. We will not return grades to your team until every team member has submitted the form.

Fill out the form here.

Submission and Grading

Submit the zip file/repo link along with the instruction file on canvas. Note that your code will NOT be graded, but the instructions would help us reproduce your project in the scenario we wish to confirm something.

In addition, all team members must individually submit the team dynamics assessment form.

We will grade the project using the following criteria:

  • the amount of effort you put in
  • how complete you were in terms of what you set out to do
  • overall quality of your work
  • how creative/exploratory/innovative/pro-active/ambitious you were in trying out things.