From ed3152aa2bb25d639b456fcd9989c73d8e3b741a Mon Sep 17 00:00:00 2001
From: Andrew Lalis <andrewlalisofficial@gmail.com>
Date: Wed, 25 Jan 2023 13:28:00 +0100
Subject: [PATCH] Added more docs.

---
 gymboard-app/src/api/gymboard-api.ts             | 10 +++++++++-
 gymboard-app/src/pages/gym/GymSubmissionPage.vue | 15 +++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/gymboard-app/src/api/gymboard-api.ts b/gymboard-app/src/api/gymboard-api.ts
index b1dac84..9685057 100644
--- a/gymboard-app/src/api/gymboard-api.ts
+++ b/gymboard-app/src/api/gymboard-api.ts
@@ -31,12 +31,20 @@ export interface ExerciseSubmission {
   createdAt: string,
   gym: SimpleGym,
   exercise: Exercise,
-  status: string,
+  status: ExerciseSubmissionStatus,
   submitterName: string,
   weight: number,
   reps: number
 }
 
+export enum ExerciseSubmissionStatus {
+  WAITING = 'WAITING',
+  PROCESSING = 'PROCESSING',
+  FAILED = 'FAILED',
+  COMPLETED = 'COMPLETED',
+  VERIFIED = 'VERIFIED'
+}
+
 export interface Gym {
     countryCode: string,
     countryName: string,
diff --git a/gymboard-app/src/pages/gym/GymSubmissionPage.vue b/gymboard-app/src/pages/gym/GymSubmissionPage.vue
index 41e5aac..e3101b0 100644
--- a/gymboard-app/src/pages/gym/GymSubmissionPage.vue
+++ b/gymboard-app/src/pages/gym/GymSubmissionPage.vue
@@ -1,3 +1,15 @@
+<!--
+This is the submission page, where users can submit their lift to a particular
+gym's leaderboards.
+
+A high-level overview of the submission process is as follows:
+
+1. The user uploads a video of their lift, and receives a `videoId` in return.
+2. The user submits their lift's JSON data, including the `videoId`.
+3. The API responds (if the data is valid) with the created submission, with the status WAITING.
+4. Eventually the API will process the submission and status will change to either COMPLETED or FAILED.
+
+-->
 <template>
   <q-page v-if="gym">
     <q-form @submit="onSubmitted">
@@ -50,6 +62,7 @@
         </div>
         <div class="row">
           <q-uploader
+            id="uploader"
             :url="getUploadUrl(gym)"
             :label="$t('gymPage.submitPage.upload')"
             field-name="file"
@@ -83,6 +96,7 @@ import {
 } from 'src/api/gymboard-api';
 import {getGymFromRoute} from 'src/router/gym-routing';
 import SlimForm from 'components/SlimForm.vue';
+import {QUploader} from "quasar";
 
 interface Option {
   value: string,
@@ -99,6 +113,7 @@ let submissionModel = ref({
   weightUnit: 'Kg',
   reps: 1,
   videoId: -1,
+  videoFile: null,
   date: new Date().toLocaleDateString('en-CA')
 });
 const weightUnits = ['Kg', 'Lbs'];