CS1999 Buggy Racing project: your report
About the report
Because you have developed a webserver, for the CS1999 Buggy Racing project your report is — of course — a page on your webserver at:
-
http://localhost:5000/report
What is in your report?
-
a series of texts about each task you attempted
For the report text, we want to see a list of the tasks you attempted, what you did and anything you did and didn't do. This is where we can give you credit for your understanding even if you didn't manage to get all of the task working.
Suggested size for each task text:
a detailed description of how you approached this task and any challenges you encountered.
How to set up the /report page in your buggy editor
As you'll know by the time you set this up, there is more than one way to do this, but you are strongly recommended to add your report like this:
Add a new route in app.py (drop it in with your other
routes, which means somewhere before app.run()
is called):
@app.route('/report')
def report():
return render_template('report.html')
Incidentally if this makes sense to you it's because you know how Flask webservers work now... and if you didn't before the project started, how cool is that? Well done!
In templates/ add a new template file called
report.html with content like this: (maybe
copy-and-paste it?)
{% extends "base.html" %}
{% block content %}
<style>
.report-tasks {
border-top: 1px solid black;
margin-top: 4em;
}
.report-tasks .task {
margin: 1em;
padding: 1em;
border: 1px solid black;
}
.report-tasks .task h2 {
border-bottom: 3px solid gray;
}
</style>
<!-- below this point keep this section tag and paste in a <div> for every -->
<!-- task you attempted. -->
{% raw %}
<section class="report-tasks">
<!-- THIS IS WHERE YOUR TEXTS GO! -->
<!--
Paste in your texts, which you downloaded as the HTML from
https://rhul.buggyrace.net
-->
</section>
{% endraw %}
{% endblock %}
Add some text for every task you attempted
We'll be looking at the code to see what you did, but in the text just write about what you did, what was tricky, and anything you learned.
We're looking for opportunities to give you credit for having understood what you were doing. That's why it's OK if you didn't do a task completely: tell us why.
For example, for
1-VALID
the different types of data are not equally easy to validate.
"I did not validate the xyz field in the same way as
qty_wheels because…". You need to show us you
understood what you did (and learned from it) so sometimes that
includes explaining the bits you didn't do, and why.
Doing is better than not doing, obviously: but if you couldn't do
a complete task you can still get some credit for it if it's clear
you dived into it.
Storing texts on this race server
You can make notes as you go along, and download them as text or HTML format to put into your report.
Remember that this is not your report! It's simply a convenient place
to collect your texts as you go along.
You still have to manage putting them into the report
page of your buggy editor.
However, there are buttons for downloading your texts
which will already put them in a helpful HTML format, if you want.
Helpful HTML to copy-and-paste
in editor.html template.
If you create "task texts" as described above, you don't
have to do this! It's what you get when you download
your texts:
choose the download as HTML button (with markdown,
if you want).
For each task you attempted, take this HTML and add it to your
report (in the tasks section).
Remember to edit it!
Be kind to your marker and put the tasks in the right order too please ;-)
You'll need one of these for each task you attempted:
<div class="task">
<h2>TASK-NAME TASK-TITLE</h2>
<p>
<!-- your text goes here... -->
</p>
<p>
<!-- ...and more... -->
</p>
</div>