MSCC/MSCBD Assignment 01 Building a database that will store and display data about Formula 1

Introduction

NOTE: Read the whole assignment brief first, before implementing it, contains very important information. In this assignment, you will be tasked with building your first PaaS application, which will be a database that stores information about F1 drivers and teams. You will be required to deal with users who log in and logout. This will function a little like Wikipedia in that anyone who is logged in can change anything, anyone who is logged out can change nothing.

In this application, users should be able to add and update drivers and teams
that are in the database. They should also be able to perform comparisons of either teams or drivers. You will also be required to do some filtering. With filtering, however, you will be limited on the types of queries you can perform due to the NoSQL nature of Firestore. It is recommended that you structure your datastore models in such a way to make the required queries easier if possible.

1. How fully featured, complete, and robust your code is. Along with how
   Well your UI is thought out (80%)
2. How well documented your code is (20%)

NOTE: This is an individual assignment. It is not a group assignment. You can discuss ideas/algorithms, but you cannot share code/documentation

Submission and Penalties

You are required to submit two separate components to the Moodle

• An archive containing your complete Google App Engine Python project. The accepted archive formats are: zip, rar, 7z, tar.gz, tar.bz2, tar.xz. The use of any other archive format will incur a 10% penalty before grading.
• Python is the required language for the backend. The use of any other backend language, e.g. PHP, JS, will result in an automatic assignment failure
• A PDF containing documentation of your code. Copying and pasting code into a PDF does not count as documentation.

There are also a few penalties you should be aware of

• Code without a .git repository will be deducted 10%
• Remote repositories are not permitted. You are not permitted to use Github, Gitlab, BitBucket or any other remote repository. Your code will not be corrected if you use one of these.
• Code without documentation will be deducted 20%
• A git repository with less than 7 commits will be deducted 5%
• Code that fails to compile will be a failing assignment. At this stage you have zero excuse to produce non compiling code. I should be able to open your project and be able to compile and run without having to fix syntax errors.
• The use of libraries outside the SDK will incur a 20% penalty before grading. You have all you need in the standard SDK. I shouldn’t have to figure out how to install and use an external library to get your app to work
• The standard late penalties will also

Very Important: Take note of the groups listed below. These are meant to be completed in order. Groups must be completed in full before the next group will be evaluated. Completed will mean that all tasks in the groups are visible and testable. If a singlene is not
visible and testable further groups will not be considered. e.g. if there are four tasks in Group 1 and task 3 is skipped or not visible or testable then Groups 2, 3 and 4 will be ignored. Documentation will be treated separately irrespective of how many Groups you have
completed.

You should also be aware that I will remove marks for the presence of bugs anywhere in the code and this will incur a deduction of between 1% and 10% depending on the severity. If you have enough of these bugs it is entirely possible that you may not score very many marks overall. I want robust bug free code that also validates all user input to make sure it is sensible in nature. Please be aware of the major bugs section. If any of these bugs are present in your application you will lose 10%.

Plagiarism

Be aware that we take plagiarism very seriously here. Plagiarism is where you
take someone else’s work and submit it as if it was your own work. There are
many different ways plagiarism can happen. I will list a few here (this is not
exhaustive):

• Finding something similar online (full implementation or tutorial) that does the same job and submit that.
• Finding something similar online (full implementation or tutorial) and transcribing (i.e. copying it out by hand)
• Working together on an individual assignment and sharing code together such that all implementation look the same.
• Getting a copy of someone else’s code and submitting/transcribing that
• Paying someone to do your assignment. NOTE: if you are caught participating in either side of such a transaction upto 5 years after you graduate you can be stripped of your degree.
• Logging into someone elses Moodle account, downloading their assignment and uploading it to your own Moodle account.

I’ve had to deal with many cases of plagiarism over the last ten years so I can spot it and diagnose it easily, so don’t do it. To prevent plagiarism include but not limited to the following:

• Do all your code by yourself
• Don’t share your code with anyone, particularly if anyone looks for a copy of your code for reference.
• Don’t post your code publicly online. Remember the use of GitHub, Gitlab, BitBucket etc is prohibited.
• If you need to find information online only query about very specific problems you have don’t look for a full assignment or howto.
• Change the default password on your Moodle account. The default password can be determined if someone is connected to you through social media or they get one or two details from you.
• If you need to refer to anything online your only permitted source to reference is StackOverflow.
• Please note that AI tools such as ChatGPT will count as plagiarism. There use is strictly prohibited

Be aware that if you submit your assignment you accept that you understand what plagiarism is and that your assignment is not plagiarised in any way. Also be aware that if you are caught for plagiarism you will not get another opportunity or a second chance to resubmit the assignment. If you see the words “pending review” in your assignment feedback it is 99% likely that you will be called to a plagiarism meeting.

Coding Tasks (80%)

Group 1 tasks (20%)

1. Application that has a working login/logout service exactly the same as the examples through firebase-login.js. You are not permitted to do login/logout any other way.

2. Firestore collections that represent a driver and a team

• Drivers should have an Age, Total Pole Positions, Total Race Wins, Total Points Scored, Total World Titles, Total Fastest Laps, and the team they drive for
• Teams should have Year Founded, Total Pole Positions, Total Race Wins, Total Constructor Titles, Finishing position in previous season.
• Note the use of indexes on either collection is not permitted

3. Seperate pages for adding a driver to the database, and adding a team to the database.

4. Add in a form to query drivers. It should allow the user to select a single attribute. The user should also be able to choose if a less than, greater than, or equal comparison is used. A list of all drivers satisfying the query should be displayed

Group 2 tasks (40%)

5. Add in a form to query teams. It should allow the user to select a single attribute. The user should also be able to choose if a less than, greater than, or equal comparison is used. A list of all teams satisfying the query should be displayed

6. Both query forms should be accessible to logged out users.

7. Each driver should be shown as a hyperlink which when clicked brings the user to a seperate page showing the information for that driver.

8. Each team should be shown as a hyperlink which when clicked brings the user to a seperate page showing the information for that team.

Group 3 tasks (60%)

9. Add in the ability to edit a driver and update their attributes if a user is logged in

10. Add in the ability to edit a team and update their attributes if a user is logged in

11. Add the ability to delete a driver or team from the database if a user is logged in

12. Add in a seperate page for comparing two drivers against each other

Group 4 tasks (80%)

13. Add in a seperate page for comparing two drivers against each other

14. For the comparison of drivers show a 2 column table of their stats with the better stat highlighted green. Team should not be compared. Everything except age, the higher number should be highlighted. Age should be lower.

15. For the comparison of teams show a 2 column table of their stats with the better stat highlighted green. Everything except finishing position and year the higher number should be highlighted. For finishing position and year the lower number should be highlighted.

16. UI Design: UI that is easy and intuitive to use

Major bugs (presence of each of these will be a 10% reduction in mark)

• It is possible to add two drivers with the same name
• It is possible to add two teams with the same name
• Editing a driver edits the wrong driver
• Editing a team edits the wrong team
• Deleting a driver deletes the wrong driver
• Deleting a team deletes the wrong Team
• It is possible to trigger a comparison with 0 or 1 teams

Documentation Brackets (20%)

NOTE: Documentation should be around 1,500 words in length total

1. (20%): Document every method in your code from a high level perspective.
   i.e. give an overview of what the method does. Do not copy and paste code you will be penalised for this.