Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Added Screenshots and updated Contributions
  • Loading branch information
@yanavlall
yanavlall authored Mar 14, 2024
1 parent 814c016 commit 08a09a6
Showing 1 changed file with 33 additions and 11 deletions.
44 changes: 33 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!--
![image](https://github.com/CS342/2024-Stronger/assets/121056442/901a7d82-9c32-448a-8f5e-088d535356bf)<!--

This source file is part of the Stronger based on the Stanford Spezi Template Application project

Expand Down Expand Up @@ -33,68 +33,90 @@ 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)


#### 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

The Weekly Stats button takes the user to the Weekly Protein Intake Data page, allowing the user to take a look at their protein consumption over the last week.
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

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.
It shows the current week and last week's progress. If it is the first week for the participant, only one week will be shown.
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

For week selection We use the account information. See Account info for more details.
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.

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.
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.

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

ProBot is a gpt-powered chatbot that logs in the user's protein intake. It performs two main tasks:
1. It asks the user what they had for their last meal and extracts the protein content for each food item based on its quantity. To do this, it utilizes an external nutrition API to get the protein content for each food item per 100 grams.
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

## 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)

> [!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)

## Contributing

Theo: Augmenting Account. Weekly summary on Home Page. Workout Selection, Workout day and week selection.
Logic for determining current week and curreent exercise day.

Tulika: ProBot (chatbot for logging in protein intake). Protein ring on Home Page. Weekly Stats view for weekly protein intake.
Logic for storing and retrieving protein data from Firestore.

Mena: Creating Input Form for user to submit workout information, reading and writing data from Firestore
Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first. You can find a list of contributors in the Contributors.md.

## License

Expand Down

0 comments on commit 08a09a6

Please sign in to comment.