This PR is all about how we are modeling our questions and documentation -- from their representation in our modeling, to our chosen file structure and naming conventions. You can see more fine details in the ReadMe, but I am also putting them below the Time Authentication region for your easy access. Also note: We implemented Markdown instead of HTML for ease of writing but that can be updated back easily!
Questions
We chose to package all document handling between the frontend and the backend into one API Request -- /questions/questions
In the future, there may be a need to be more granular, but for now the MVP will send a QuestionsPublic model that holds both global documentation and a list of question models to the front end (The question models have their own documentation as well.)
Time Authentication
This API request is protected by a check to assure the team is accessing the questions within their time slot.
Important ReadMe info for this branch:
ES File Structure and Question formatting
General File Structure
The general ES file structure should maintained in the following format, and any deviation may cause some backend components to break:
The teams subdirectory holds all data for interacting with the Team tables in the database. As of now, there are two important files:
File
Description
teams.csv
File containing a snapshot of the Team table in the database.
unique_words_reset.csv
File containing a list of gradeschool level words for password generation
questions Subdirectory Information
The questions Subdirectory holds information for the test, where it's subdirectories, following the convention q#, represent questions and contain all relevant files.
File
Description
prompt.md
This Markdown file holds the question body.
doc_<title>.md
Markdown files with the prefix doc_ are question specific/supplemental documentation.
test_cases.py
This python file is for final submission grading by the ES.
demo_cases.py
This python file is for validation testing by the students.
global_docs Subdirectoy Information
The global_docs subdirectory holds all documentation made available regardless of question. All Markdown file in this directory will be made available for reference during test time.
Overview
This PR is all about how we are modeling our questions and documentation -- from their representation in our modeling, to our chosen file structure and naming conventions. You can see more fine details in the ReadMe, but I am also putting them below the Time Authentication region for your easy access. Also note: We implemented Markdown instead of HTML for ease of writing but that can be updated back easily!
Questions
We chose to package all document handling between the frontend and the backend into one API Request -- /questions/questions In the future, there may be a need to be more granular, but for now the MVP will send a QuestionsPublic model that holds both global documentation and a list of question models to the front end (The question models have their own documentation as well.)
Time Authentication
This API request is protected by a check to assure the team is accessing the questions within their time slot.
Important ReadMe info for this branch:
ES File Structure and Question formatting
General File Structure
The general ES file structure should maintained in the following format, and any deviation may cause some backend components to break:
teamsSubdirectory InformationThe
teamssubdirectory holds all data for interacting with the Team tables in the database. As of now, there are two important files:teams.csvunique_words_reset.csvquestionsSubdirectory InformationThe
questionsSubdirectory holds information for the test, where it's subdirectories, following the convention q#, represent questions and contain all relevant files.prompt.mddoc_<title>.mddoc_are question specific/supplemental documentation.test_cases.pydemo_cases.pyglobal_docsSubdirectoy InformationThe
global_docssubdirectory holds all documentation made available regardless of question. All Markdown file in this directory will be made available for reference during test time.