From 0f47c17ce974fa46e4fb406faeb11e601c43ba84 Mon Sep 17 00:00:00 2001 From: Mena Hassan <34526502+menahassan@users.noreply.github.com> Date: Thu, 14 Mar 2024 19:46:01 -0700 Subject: [PATCH] Fix Table for Screenshots (#77) # Fix Table for Screenshots ## :recycle: Current situation & Problem *Link any open issues or pull requests (PRs) related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.* ## :gear: Release Notes *Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.* *Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.* ## :books: Documentation *Please ensure that you properly document any additions in conformance to [Spezi Documentation Guide](https://github.com/StanfordSpezi/.github/blob/main/DOCUMENTATIONGUIDE.md).* *You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.* ## :white_check_mark: Testing *Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.* *This section describes important information about the tests and why some elements might not be testable.* ## :pencil: Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md). --- README.md | 41 ++++++++++++++++++----------------------- 1 file changed, 18 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e4e911b..1d8cf3f 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,17 @@ The Stronger App consists of three main screens. Home, Workout, and Food Tracking. -### Home -![5080B95E-D31C-425E-9828-A51F8CE25F55](https://github.com/CS342/2024-Stronger/assets/121056442/40827ace-e938-42f3-a4b8-85e0aa6ce47b) +| Home Screen | Daily Protein Screen | Weekly Stats Screen | +|-------------|-----------------|-------------------| +| ![Home Screen](https://github.com/CS342/2024-Stronger/assets/121056442/40827ace-e938-42f3-a4b8-85e0aa6ce47b) | ![Daily Protein Screen](https://github.com/CS342/2024-Stronger/assets/121056442/e641ee25-ddc6-40af-9757-324718963c95) | ![Local Chat Screen](https://github.com/CS342/2024-Stronger/assets/121056442/113a61b0-a06c-44cf-a9f4-2a17da642b6c) | +### Home #### Daily Protein The top half of the page features a ring to help the user track her protein intake for the day. The ring fills up as protein gets logged in for the user and changes colour from red to orange to green corresponding to 3 levels of protein intake - 0-67%, 67%-99%, 100% of daily protein target met. -![A4B1B3AF-770A-44D6-A418-6C36D7660086_1_201_a](https://github.com/CS342/2024-Stronger/assets/121056442/e641ee25-ddc6-40af-9757-324718963c95) ##### Weekly Stats @@ -51,21 +52,18 @@ The Weekly Stats button takes the user to the Weekly Protein Intake Data page, a It depicts data in the form of a bar graph with each bar showing the protein intake for a given day. It also shows the 'average' daily protein intake for the week and the 'target' daily protein intake, helping the user understand how well they have been meeting their goals over the last 7 days. -![FBA259A9-0861-4544-9322-BD2C901AB0AC](https://github.com/CS342/2024-Stronger/assets/121056442/113a61b0-a06c-44cf-a9f4-2a17da642b6c) - +| Estimating portion size | Log Protein with Pro-Bot | Weekly Fitness Progress | +|-------------|-----------------|-------------------| +| ![Estimating portion size](https://github.com/CS342/2024-Stronger/assets/121056442/8150613d-2029-4754-bfd3-4d5c1c04abf0) | ![Log with Pro-Bot](https://github.com/CS342/2024-Stronger/assets/121056442/934f5334-2c74-49b0-bb44-0e6fd08eec1b) | ![Weekly Fitness Progress](https://github.com/CS342/2024-Stronger/assets/121056442/ab98cbfc-cca9-4ba7-b628-c284087acfb6) | ##### Estimating portion size The "estimating portion size" button opens up a pdf with suggested ways in which the user can estimate the quantity of their meal while logging in their protein intake via the chatbot. -![2C92C87E-929C-47CF-B56F-FB4B05AB4435](https://github.com/CS342/2024-Stronger/assets/121056442/8150613d-2029-4754-bfd3-4d5c1c04abf0) - ##### Log more with ProBot This link is a shortcut to ProBot, the LLM-powered chatbot that logs in protein intake for the user. -![A462DA9E-572A-4208-A5F7-267ABC2E0B68](https://github.com/CS342/2024-Stronger/assets/121056442/934f5334-2c74-49b0-bb44-0e6fd08eec1b) - #### Weekly Fitness Progress The bottom half of the *Home* page is the weekly fitness progress. @@ -73,10 +71,11 @@ It shows the current week and last week's progress. If it is the first week for THe three buttons will navigate to workout selection. Each button has a text below that will show if the exercise day was on average "Easy", "Medium", "Hard" or of it is incomplete. -![E2EE987C-8A9A-4206-AD1F-1C3654856B7E_1_201_a](https://github.com/CS342/2024-Stronger/assets/121056442/ab98cbfc-cca9-4ba7-b628-c284087acfb6) - ### Workout +| Workout selection | Workout Input | Weekly Fitness Progress | +|-------------|-----------------|-------------------| +| ![Workout selection](https://github.com/CS342/2024-Stronger/assets/121056442/b40013c6-b51e-4983-bcfc-3aa774dae91a) | ![Workout Input](https://github.com/CS342/2024-Stronger/assets/121056442/ce14b1e7-4f68-4df2-8d03-a7727c9b13c9) | ![Workout Makeup Selection](https://github.com/CS342/2024-Stronger/assets/121056442/041a6ae2-59b4-43fb-9026-cedf1f609b0b) | #### Workout selection @@ -84,17 +83,20 @@ For week selection We use the account information. See Account info for more det To determine the exercise it queries the firestore to see what exercises are there. THere must be exercises for all workouts of a day for it to move onto the next exercise. For example, if Day 1 consists of Squats, Pushups, Lunge Left and Lunge Right, there must be all 4 exercises for the workout to move onto the next date. -![751FA7A8-D5DD-4E28-8FB1-8E55DEE05982](https://github.com/CS342/2024-Stronger/assets/121056442/b40013c6-b51e-4983-bcfc-3aa774dae91a) #### Workout Input The user can navigate to the Workout Input Form from the Workout Selection page. For whichever specific exercise they selected, they can input the reps, resistance, and difficulty for 3 Sets. They can also see which sets they might have already completed, and edit the information if necessary. The workout input form also has a thumbnail of the selected workout, which the user can click and be directed to the workout video for that exercise. The user can also pre-populate form with saved data from the last time they completed the current exercise. -![03E2E3E9-5926-4A65-98AE-2DFC9888390B](https://github.com/CS342/2024-Stronger/assets/121056442/ce14b1e7-4f68-4df2-8d03-a7727c9b13c9) -#### Workout Makeup Selection. + +#### Workout Makeup Selection If the user wants to submit a workout for a particular week or exercise day, They can navigate here and select the exact week and day. -![9A8B49A9-5A04-4CF7-AA0B-D14AD67545E4](https://github.com/CS342/2024-Stronger/assets/121056442/041a6ae2-59b4-43fb-9026-cedf1f609b0b) ### Foodtracking + +| ProBot | Protein via Image Recognition | Account Details | +|-------------|-----------------|-------------------| +| ![ProBot](https://github.com/CS342/2024-Stronger/assets/121056442/22372efa-0fe9-4f1e-8b18-aa213a8efbe7) | ![Protein via Image Recognition](https://github.com/CS342/2024-Stronger/assets/155938578/ec636be8-7c3f-49e1-9142-af45fb265274) | ![Account Details](https://github.com/CS342/2024-Stronger/assets/121056442/c62e4e74-6446-4972-abd9-fce3f19b7975) | + #### ProBot ProBot is a gpt-powered chatbot that logs in the user's protein intake. It performs two main tasks: @@ -102,20 +104,13 @@ ProBot is a gpt-powered chatbot that logs in the user's protein intake. It perfo 2. It adds the total protein content from all the food items and logs in the total protein content for the meal. For this too, it makes use of function calling to store protein data for the meal into firestore. -![image](https://github.com/CS342/2024-Stronger/assets/121056442/22372efa-0fe9-4f1e-8b18-aa213a8efbe7) - - #### Protein intake via image recognition The protein intake via image recognition allows the user to click a picture of their meal to log in their protein intake. The app recognizes the food item, pre-populates the chatbot with the recognized food item and allows the user to log in their protein intake in a more hands-free manner. The user also has the option to edit the recognized food item in case the model misclassifies. -image ## Account details -Account has been augmented to include a startdate, weight, and height. - -The current week is determined by the amount of weeks from the Monday of the startdate selected. i.e. Monday is considered the start of a week. -![image](https://github.com/CS342/2024-Stronger/assets/121056442/c62e4e74-6446-4972-abd9-fce3f19b7975) +Account has been augmented to include a startdate, weight, and height. The current week is determined by the amount of weeks from the Monday of the startdate selected. i.e. Monday is considered the start of a week. > [!NOTE] > Do you want to learn more about the Stanford Spezi Template Application and how to use, extend, and modify this application? Check out the [Stanford Spezi Template Application documentation](https://stanfordspezi.github.io/SpeziTemplateApplication)