diff --git a/docs/Templates/Project-Templates/Component-Review.md b/docs/Templates/Project-Templates/Component-Review.md index 2ec693adb..e25c36006 100644 --- a/docs/Templates/Project-Templates/Component-Review.md +++ b/docs/Templates/Project-Templates/Component-Review.md @@ -1,36 +1,51 @@ # Ontrack Component review -## Team Member Name - -First select a component to review from the list below: - +## Team Member Name : Lovleen Kala ## Component Name -Here you should enter the component name, also list all the files in this component. +File Uploader + +List of Files in this Component: + +file-uploader.component.html + +file-uploader.component.scss + +file-uploader.coffee ## Component purpose -What is the primary purpose of this component and how doesit work? Screenshots are advised. +The File Uploader component provides a interface for uploading files within the OnTrack platform. It is designed to handle various file formats, validate file types, and trigger events for successful uploads. This component is crucial for managing group-related files, such as CSV imports for group sets and student data. +This component is being used in severla other componnets. +![image](https://github.com/user-attachments/assets/763cb246-24ef-4273-96ec-a23c7481c084) + +Before Migration: +![image](https://github.com/user-attachments/assets/8667e2f1-bc4b-4dec-bb04-33a7f86d9469) + ## Component outcomes and interactions -What are the expected outcomes of the component and what does it interact with, what kind of data -objects is it taking in and passing out? +The File Uploader component interacts with the Group Set Editor and Group Member List components, csv-upload-modal, portfolio-add-extra-files-step,portfolio-learning-summary-report-step, upload-submission-modal, task-ilo-alignment-edior. It takes in file objects and uploads them to a specified endpoint, triggering success and completion events. It can pass the uploaded file data to the parent component for further processing. -## Component migration plan +Expected Outcomes: + +Successful file upload triggers an 'on-success' event. +Completion of the entire upload triggers an 'on-complete' event. +Error handling for unsupported file types or exceeding file size limits. -First add your plan for the migration, how will you do this, what steps are needed. Add some -sketches or diagrams, what will the migrated component look like compared to the current one. +Data Objects: -## Component review checklist +File Object: Represents the uploaded file. +Upload Progress: Tracks the progress of the current upload. +Upload Status: Indicates the current state (uploading, completed, failed). -Next add a checklist similar to: then create a checklist: -[ ] ability to collect details from the user [ ] succeeds when data is valid [ ] handles errors - -duplicate unit code in the teaching period, or invalid dates [ ] created unit is shown on success +## Component migration plan + +I aim on following the migration guide in order to migrate this componnet. After completing the code I plan on testing all the components with the parent components to make sure that everything works. ## Discussion with Client (Andrew Cain) Finally you will need to take the feedback from Andrew and Discuss any addtional considertions he -may have with this component before writing any code. +may have with this component before writing any code. \ No newline at end of file