si364-fa18/midterm-instructions

INSTRUCTIONS for the midterm assignment for SI 364 (Currently F18)

SI 364 - Fall 2018 - Midterm Assignment

Deadline: November 4, 2018 11:59 PM

Total: 2000 points

Overall

You do NOT need to fork or clone this, and should not -- only the instructions live here. Everything else we provide lives on Canvas.

YOU SHOULD READ THIS ENTIRE SET OF INSTRUCTIONS CAREFULLY BEFORE BEGINNING YOUR WORK.

In this take-home midterm assignment, your goal is to build on provided code to build a complete working interactive application, using the material you have learned in this class so far:

• Putting correct setup code into your app file
• Dynamic routes (using data from the URL)
• Links
• Building templates with template inheritance
• Planning and defining view functions to send data to templates
• Forms with WTForms
• GET and POST requests
• Redirects
• SQLAlchemy and Models
• And certainly, debugging and more along the way...

Info on collaboration (none) and work on this assignment

Unlike most HW in this class, you should not share any code you are working on for this assignment. It should be your own work. You may talk generally about concepts ("where's some good documentation for WTForms", "I'm getting this error, what do you suggest I try to do?") but nothing specific (like "can you look at my code and help talk me through it" -- that's great for HW, but not for this practice midterm assignment).

By submitting the assignment you are asserting that you completed this project with academic integrity and did not share your code with others.

You may, of course, talk with any instructors, post (without showing your code) on Piazza (we will monitor and edit any question with too much information in it), and use the internet, any resources from HW, section, or lecture, textbook, readings, etc.

If you use any code from the internet or directly from class, you must cite it. You CANNOT fulfill creative requirements for this assignment (e.g. defining a complete view function) with any code that comes from lecture, section, the internet, a friend, or a previous assignment, although if you include it AND cite it (see syllabus for how), that's OK, it just won't count for points.

(Setup code, like app.config settings, is always approximately the same and will not vary much from one person to another, if it all. You do not have to cite that, but you do need to make sure you have what you need!)

Instructions

We have provided a .zip file on Canvas (in the directory Files > Midterm Assignment) called SI364midterm.zip. This contains the file SI364midterm.py that includes some view functions, some models, some setup code, some comments to indicate what you may need to add and how to organize your code, a templates directory with 2 templates inside, and a sample README.md template. The SI364midterm.py file does NOT include all of the setup code necessary for an app to run.

You should add to the SI364midterm.py file and the templates/ files to accumulate points, to fulfill the requirements listed below.

Note that some requirements are dependent upon another one being completed successfully, as in all applications!

The code we have provided is fairly basic, in that it could apply to any subject or theme. Everything else you can fill in for this midterm assignment may be of any theme or any subject you want, and involve any data (as long as it is appropriate to share with our whole class, and does not include any discriminatory content).

You may not earn any points for making a request to the iTunes API since we have used it so many times in class. You may use any other REST API, as long as you do not use code that is exactly the same as code used in lecture or section or a previous HW. (So your use of an API you've seen before must be different from anything we have done in class!)

It is not enough to decide that the app you want to write does not have that type of feature -- the midterm assignment requires fulfilling all of these things for the credit that goes with them, so make your plan accordingly.

Reading code you have been given already, written already, and looking at examples from lecture, section, and past HW is one of the best ways to approach this. While you can't use the code directly, it can answer a lot of possible questions and provide great examples!

I recommend writing an outline of your documentation first, and then writing a lot of comments in your SI364midterm.py file to subsequently translate into code.

Design will not earn you points for this assignment thoug you may certainly include it if you want -- do not prioritize it over the functionality, which is what this midterm assignment is about.

Requirements to complete for 1800 points (90%) -- an awesome, solid app

(I recommend treating this as a checklist and checking things off as you get them done!)

Documentation Requirements (so we can grade the assignments)

• Note: See To Submit for submission instructions.
• The README.md file should include a list of all of the routes that exist in the app and the names of the templates each one should render (e.g. /form -> form.html, like the list we provided in the instructions for HW2).
• The README.md file should contain at least 1 line of description of what your app is about or should do.

Code Requirements

Note that many of these requirements go together!

• Ensure that the SI364midterm.py file has all the setup (app.config values, import statements, code to run the app if that file is run, etc) necessary to run the Flask application, and the application runs correctly on http://localhost:5000 (and the other routes you set up)
• Add navigation in base.html with links (using a href tags) that lead to every other viewable page in the application. (like this )
• Ensure that all templates in the application inherit (using template inheritance, with extends) from base.html and include at least one additional block.
• Include at least 2 additional template .html files we did not provide.
• At least one additional template with a Jinja template for loop and at least one additional template with a Jinja template conditional.
  • These could be in the same template, and could be 1 of the 2 additional template files.
• At least one errorhandler for a 404 error and a corresponding template.
• At least one request to a REST API that is based on data submitted in a WTForm.
• At least one additional (not provided) WTForm that sends data with a GET request to a new page.
• At least one additional (not provided) WTForm that sends data with a POST request to the same page.
• At least one custom validator for a field in a WTForm.
• At least 2 additional model classes.
• Have a one:many relationship that works properly built between 2 of your models.
• Successfully save data to each table.
• Successfully query data from each of your models (so query at least one column, or all data, from every database table you have a model for).
• Query data using an .all() method in at least one view function and send the results of that query to a template.
• Include at least one use of redirect. (HINT: This should probably happen in the view function where data is posted...)
• Include at least one use of url_for. (HINT: This could happen where you render a form...)
• Have at least 3 view functions that are not included with the code we have provided. (But you may have more! Make sure you include ALL view functions in the app in the documentation and ALL pages in the app in the navigation links of base.html.)

Additional Requirements for an additional 200 points (to reach 100%) -- an app with extra functionality!

• (200 points) Write code in your Python file that will allow a user to submit duplicate data to a form, but will not save duplicate data (like the same user should not be able to submit the exact same tweet text for HW3).

100 points extra credit

• (100 points) Include an additional model class (to make at least 3 total in the application) with at least 3 columns. Save data to it AND query data from it; use the data you query in a view-function, and as a result of querying that data, something should show up in a view. (The data itself should show up, OR the result of a request made with the data should show up.)

To submit

• Commit all changes to your git repository. Should include at least the files:
  • README.md
  • SI364midterm.py
  • A templates/ directory with a file base.html and name_example.html plus the others you have created inside it
• Create a GitHub repository called 364F18midterm on your GitHub account. (You are NOT forking and cloning anything this time, you are creating your own repo from start to finish.)
• Submit the link to your GitHub repository to the SI 364 Midterm assignment on our Canvas site. The link should be of the form: https://github.com/YOURGITHUBUSERNAME/364midterm (if it doesn't look like that, you are probably linking to something specific inside the repo, so make sure it does look like that).

All set!