ameobea / amc-web-ui Goto Github PK

We should either enforce one and only one question is selected as correct or find a way to configure the TeX to have partial credit or some other kind of scheme.

For now, submitting with anything other than one correct answer triggers an error.

• Wrap the "prepare" functionality that takes a TeX file and creates the PDFs.
  • Should take arguments that are then mapped into arguments for the AMC command line application
  • Docs on the arguments that are needed: https://project.auto-multiple-choice.net/projects/auto-multiple-choice/wiki/Using_AMC_in_command_line_only#Prepare-tests

• Make sure that there is at least one selected correct answer
• Make sure that all fields have values
• If there are any validation issues, display in the UI what the problem is and don't allow the user to submit

Whenever a new quiz is generated, an answer sheet with the answers already filled in is also generated. I think this would be helpful in the future and an effortless feature for the instructors that they could appreciate.

The frontend should detect if endpoints that it expects to return a file give non-200 status codes. Display an alert or something and don't attempt to download the request body.

• Modify application state to handle storing all of these different questions

More details to be decided

This is taken from our meeting minutes I have a very limited understanding of why its in there.

General styling and formatting needs to be done for the application. The goal is to make is a presentable as possible, so anything we can do is a plus.

As of now, the checkboxes are non-functional. Should probably be attached to some sort of binary state in the answers array (perhaps a nested array or an array of objects?).

When we're calling the AMC scripts via the Python webserver, we should verify if they succeeded or not. If they did not succeed or encountered an error during execution, we should reflect that in the response from the API by returning an error code (HTTP error 500, 400, etc.) and include information about the error.

For situations where information is returned by the AMC programs, that information should be serialized (JSON?) and returned to the user with a 200 response code.

For association with students in grading

• Should create the project in a temporary directory. Can be handled though Python directly: https://docs.python.org/2/library/tempfile.html
• Should create the basic project schema in that directory. Can either be accomplished by copying in a baseline project or following the steps here: https://project.auto-multiple-choice.net/projects/auto-multiple-choice/wiki/Using_AMC_in_command_line_only#Creating-a-new-project
• Should return the path to that directory so that it can be used with AMC command line scripts
• Should include a function for deleting these directories when they're no longer used (if that functionality isn't covered by Python already)

Professor Thomas wishes to generate blocks of questions (as is currently happening). However, he would like to create multiple blocks, whose order is randomized.

AMC says it accepts PNG, JPG, TIFF, PDF, among others and we should accept any of those.

To differentiate from other issue, this should output the blank quizzes for the instructor to print and use (likely sent through email).

AMC is not recognizing the setdefaultgroupmode LaTeX command, which some searching on Google suggests is due to a version mismatch. I'm not sure if this is fixed inside of Docker or not, if this is required for question/answer shuffling, or other things; additional research will be required to figure that out.

• Create GUI in the frontend that includes instructions for how to upload the files and uploads the files to a route on the backend
  • Should do some basic verification of the uploaded files to make sure that they're the right file type, etc.
  • Should include the ability to either tag the test with a student ID (if that's not handled at some other point down the road)
• Create backend route that accepts the files and copies them to a temporary directory
• Create Python function that calls the AMC script to analyze the uploaded scans
  • Docs for this: https://project.auto-multiple-choice.net/projects/auto-multiple-choice/wiki/Using_AMC_in_command_line_only#Analyzing-the-copies

Add spot in the UI to add (optional) custom text (or perhaps even TeX directly) to be added into the header of the generated test and inject it into the generated TeX file. This will have to be stored in the database as well to make sure that layouts match exactly.

The Frontend should call into APIs from the backend and display the result of those actions. It should handle this in an asynchronous manner and deal with errors reported by the backend or in the connections.

This should be passed to the backend and replace the dummy student list that we generate currently.