(DOCS): Updated tech specs

This commit is contained in:
Hayden Hargreaves 2025-07-01 19:49:35 -07:00
parent c2cc8c8183
commit 519b71f72d

View File

@ -135,50 +135,50 @@ creation process will take place here
##### UI Requirements
- [ ] Create Recipe Heading Banner
- [ ] Large, simple text banner that displays a header
- [ ] Smaller text section that contains some useful information for using the wizard
- [x] Create Recipe Heading Banner
- [x] Large, simple text banner that displays a header
- [x] Smaller text section that contains some useful information for using the wizard
- [ ] Recipe Creation Wizard
- [ ] **Recipe Details:** required
- [ ] **Recipe title:** small text input (1 to 128)
- [ ] **Recipe description:** large text input
- [ ] **Meal category:** pill radio buttons or drop down*
- [ ] **Service size:** numeric input (1 to 16)
- [ ] **Difficulty rating:** star buttons that can be selected (up to 5)
- [ ] **Duration:** prep and cook time, individual numeric inputs
- [ ] **Ingredients:** required
- [ ] **Dynamic ingredient list:** List of each ingredient
- [ ] **Content:** name and quantity (both text inputs)
- [x] Recipe Creation Wizard
- [x] **Recipe Details:** required
- [x] **Recipe title:** small text input (1 to 128)
- [x] **Recipe description:** large text input
- [x] **Meal category:** pill radio buttons or drop down*
- [x] **Service size:** numeric input (1 to 16)
- [x] **Difficulty rating:** star buttons that can be selected (up to 5)
- [x] **Duration:** prep and cook time, individual numeric inputs
- [x] **Ingredients:** required
- [x] **Dynamic ingredient list:** List of each ingredient
- [x] **Content:** name and quantity (both text inputs)
- [ ] **Actions:** delete button and **reorder element***
- [ ] **Add ingredient button:** Simple button to add a blank ingredient row
- [ ] **Instructions:** required
- [ ] **Dynamic instructions list:** Numbered list of each instruction
- [ ] **Content:** number and large text instruction
- [x] **Add ingredient button:** Simple button to add a blank ingredient row
- [x] **Instructions:** required
- [x] **Dynamic instructions list:** Numbered list of each instruction
- [x] **Content:** number and large text instruction
- [ ] **Rich text editor?***
- [ ] **Actions:** delete button and **reorder element***
- [ ] **Add step button:** Simple button to add a blank instruction element
- [ ] **Media & Tags:** optional
- [ ] **Image Upload**
- [ ] Single image selector for the thumbnail image
- [ ] Small image display once one has been upload
- [ ] Remove button to remove the image
- [ ] Replace button to replace the image
- [ ] **Tags**
- [ ] Text input to add tags
- [x] **Add step button:** Simple button to add a blank instruction element
- [x] **Media & Tags:** optional
- [x] **Image Upload**
- [x] Single image selector for the thumbnail image
- [x] Small image display once one has been upload
- [x] Remove button to remove the image
- [x] Replace button to replace the image
- [x] **Tags**
- [x] Text input to add tags
- [ ] Using list of existing tags, use a prefill while typing
- [ ] Tags that don't exist will be added
- [ ] Display a small list of added tags
- [ ] Clicking a tag will remove it from the list
- [ ] **Footer & Submit**
- [ ] Save recipe button to complete the form
- [x] Tags that don't exist will be added
- [x] Display a small list of added tags
- [x] Clicking a tag will remove it from the list
- [x] **Footer & Submit**
- [x] Save recipe button to complete the form
- [ ] Button is disabled until the minimum required fields are complete*
- [ ] Input Validation
- [ ] Required elements should have a **required indicator**
- [ ] Required elements will be validated input
- [x] Input Validation
- [x] Required elements should have a **required indicator**
- [x] Required elements will be validated input
- [ ] **Valid:** Green outline or indicator* maybe a small, green check mark
- [ ] **Invalid:** Red outline or indicator* maybe a red border with error text
- [x] **Invalid:** Red outline or indicator* maybe a red border with error text
'*': Not sure yet, still under consideration
@ -187,13 +187,13 @@ creation process will take place here
##### API Requirements
- [ ] Middleware
- [ ] **Authentication:** User must be logged in to access this page
- [ ] **Authentication:** User must be logged in to submit the creation of a recipe (fallback)
- [x] Middleware
- [x] **Authentication:** User must be logged in to access this page
- [x] **Authentication:** User must be logged in to submit the creation of a recipe (fallback)
- [ ] Recipe Creation Wizard
- [ ] Create a new recipe object in the database
- [ ] Recipe should be attached to a user (logged in)
- [x] Recipe Creation Wizard
- [x] Create a new recipe object in the database
- [x] Recipe should be attached to a user (logged in)
- [ ] User should be directed to the view recipe page on a successful creation