Skip to content

Commit b0a5114

Browse files
Update README.md (#120)
# *Name of the PR* ## ♻️ 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.* ## ⚙️ 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.* ## 📚 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.* ## ✅ 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.* ## 📝 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): - [ ] 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).
1 parent 564fb29 commit b0a5114

File tree

1 file changed

+44
-22
lines changed

1 file changed

+44
-22
lines changed

README.md

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -35,25 +35,38 @@ The App consists of four main screens.
3535
### Activity
3636
The Activity module in Stanford 360 features a progress ring that tracks daily physical activity, aiming for 60 minutes. Users can log activities like Walking, Running, and Sports by selecting a date and entering active minutes. Logged activities sync with Firestore, HealthKit, and local storage. HealthKit integration converts steps into active minutes (100 steps/min), with a warning if disconnected.
3737

38+
<table>
39+
<tr>
40+
<td><img src="https://github.com/user-attachments/assets/018c545c-1b34-420d-85e2-f8b3f9856c6b#gh-light-mode-only" width="250"></td>
41+
<td><img src="https://github.com/user-attachments/assets/29efa538-c3f0-465e-9096-3637dfd44647#gh-dark-mode-only" width="250"></td>
42+
<td><img src="https://github.com/user-attachments/assets/d100c139-fc57-49ee-bf81-15c1d3974e2c#gh-light-mode-only" width="250"></td>
43+
<td><img src="https://github.com/user-attachments/assets/cd801be2-c51b-49f3-aafd-25398df0ad54#gh-dark-mode-only" width="250"></td>
44+
</tr>
45+
</table>
46+
3847
### Hydration
3948
The central focus is a progress ring that visually represents the user's current water intake. Below, users can quickly log their hydration using preset portion buttons, each featuring clear icons for different drink sizes. A "Log Water Intake" button ensures seamless entry, while a reset button allows users to easily correct accidental logs. Any additions or deletions will be saved to or removed from Firestore, ensuring that hydration data is securely stored and synchronized across devices. Changes will also automatically update the corresponding card in the History View, maintaining real-time accuracy in tracking.
4049

41-
<img src="https://github.com/user-attachments/assets/386052d2-c30d-4c04-a642-8c8dd73ffb24#gh-light-mode-only" width="25%">
42-
<img src="https://github.com/user-attachments/assets/991e1ca4-d702-482f-bf7b-53737a38e857#gh-dark-mode-only" width="25%">
43-
<img src="https://github.com/user-attachments/assets/d5f7f580-c4aa-4859-ae89-3756ee9c8799#gh-light-mode-only" width="25%">
44-
<img src="https://github.com/user-attachments/assets/2d1bc9ea-1b64-4107-a858-d22f55784fde#gh-dark-mode-only" width="25%">
50+
<table>
51+
<tr>
52+
<td><img src="https://github.com/user-attachments/assets/386052d2-c30d-4c04-a642-8c8dd73ffb24#gh-light-mode-only" width="250"></td>
53+
<td><img src="https://github.com/user-attachments/assets/991e1ca4-d702-482f-bf7b-53737a38e857#gh-dark-mode-only" width="250"></td>
54+
<td><img src="https://github.com/user-attachments/assets/d5f7f580-c4aa-4859-ae89-3756ee9c8799#gh-light-mode-only" width="250"></td>
55+
<td><img src="https://github.com/user-attachments/assets/2d1bc9ea-1b64-4107-a858-d22f55784fde#gh-dark-mode-only" width="250"></td>
56+
</tr>
57+
</table>
4558

4659
### Protein
4760
The protein module designed to help users monitor their daily protein intake through interactive charts, milestone feedback, and AI-powered meal recognition. The app provides a visual representation of daily protein intake, displaying it through a chart and sending milestone notifications every time the intake reaches 20 grams, offering positive reinforcement to encourage healthy eating habits. Users can log their meals using two entry methods: manual entry, where they input food items and specify protein content, and picture-based entry, where they upload meal images. The backend processes these images by concurrently sending requests to two models to identify the meal name, while SpeziLLM analyzes the meal’s protein content and automatically fills in the intake data. Additionally, the app enables users to store and retrieve meal images and intake records, allowing them to track their nutrition history in detail. Future enhancements include integrating additional food databases for improved accuracy and providing personalized nutrition insights based on dietary patterns.
4861

49-
<img src="https://github.com/user-attachments/assets/1cee00ac-0791-4e98-aa4f-eb5aa431aa43#gh-light-mode-only" width="25%">
50-
<img src="https://github.com/user-attachments/assets/9baedd9e-f2cd-4e5e-abb9-87e9fba618fa#gh-dark-mode-only" width="25%">
51-
<img src="https://github.com/user-attachments/assets/caf88f14-f049-4c91-9141-28ee3c227ccc#gh-dark-mode-only" width="25%">
52-
<img src="https://github.com/user-attachments/assets/bafd39fe-d6c9-4cf1-815d-be36655ca002#gh-light-mode-only" width="25%">
53-
<img src="https://github.com/user-attachments/assets/2b77d8aa-ebd2-4bf4-9be5-352a94fa3517#gh-light-mode-only" width="25%">
54-
55-
56-
62+
<table>
63+
<tr>
64+
<td><img src="https://github.com/user-attachments/assets/1abee39f-5b83-43c7-8758-e54b45eb69ea#gh-light-mode-only" width="250"></td>
65+
<td><img src="https://github.com/user-attachments/assets/8bc09404-7496-4f7c-9955-2e525599907e#gh-dark-mode-only" width="250"></td>
66+
<td><img src="https://github.com/user-attachments/assets/ec7b8ac7-2a08-4216-a5d8-3f0261b46644#gh-light-mode-only" width="250"></td>
67+
<td><img src="https://github.com/user-attachments/assets/caf88f14-f049-4c91-9141-28ee3c227ccc#gh-dark-mode-only" width="250"></td>
68+
</tr>
69+
</table>
5770

5871
In addition to the specific features of each screen, we also provide essential functionalities that enhance the overall app experience and ensure seamless integration across all features.
5972

@@ -63,12 +76,17 @@ The History feature allows users to track their complete past records for Protei
6376
### Discover
6477
The Discover feature provides suggestions and educational insights for Protein, Activity, and Hydration, helping users make informed choices and build healthier habits.
6578

66-
<img src="https://github.com/user-attachments/assets/878d0105-7219-4129-8392-a4e94034780a#gh-light-mode-only" width="25%">
67-
<img src="https://github.com/user-attachments/assets/70d4ddb9-caf7-4b0c-be64-f6d4c721b55e#gh-dark-mode-only" width="25%">
68-
<img src="https://github.com/user-attachments/assets/0fcefe4a-0af9-4d3f-b8aa-dffa73aefc89#gh-light-mode-only" width="25%">
69-
<img src="https://github.com/user-attachments/assets/119fc31b-780c-4529-8b7c-79f4a0a95b7d#gh-dark-mode-only" width="25%">
70-
<img src="https://github.com/user-attachments/assets/881d95ef-0e9b-4dc9-b385-9c850dfbac1d#gh-light-mode-only" width="25%">
71-
<img src="https://github.com/user-attachments/assets/79bc6d15-ffb4-4671-913d-0d176dcb428e#gh-dark-mode-only" width="25%">
79+
<table>
80+
<tr>
81+
<td><img src="https://github.com/user-attachments/assets/878d0105-7219-4129-8392-a4e94034780a#gh-light-mode-only" width="250"></td>
82+
<td><img src="https://github.com/user-attachments/assets/70d4ddb9-caf7-4b0c-be64-f6d4c721b55e#gh-dark-mode-only" width="250"></td>
83+
<td><img src="https://github.com/user-attachments/assets/0fcefe4a-0af9-4d3f-b8aa-dffa73aefc89#gh-light-mode-only" width="250"></td>
84+
<td><img src="https://github.com/user-attachments/assets/119fc31b-780c-4529-8b7c-79f4a0a95b7d#gh-dark-mode-only" width="250"></td>
85+
<td><img src="https://github.com/user-attachments/assets/881d95ef-0e9b-4dc9-b385-9c850dfbac1d#gh-light-mode-only" width="250"></td>
86+
<td><img src="https://github.com/user-attachments/assets/79bc6d15-ffb4-4671-913d-0d176dcb428e#gh-dark-mode-only" width="250"></td>
87+
</tr>
88+
</table>
89+
7290

7391

7492
### Milestone/Goal
@@ -78,10 +96,14 @@ A goal check text is displayed in the center of each view. Before reaching 60, i
7896
#### Milestone Tracking
7997
Every 20-unit increment triggers a milestone message to encourage progress. Upon reaching 60 units, a special milestone message appears, celebrating the achievement along with the current streak day.
8098

81-
<img src="https://github.com/user-attachments/assets/fba07491-de2f-4417-8944-1c3d4f91bc92#gh-light-mode-only" width="25%">
82-
<img src="https://github.com/user-attachments/assets/17d529d2-be3f-4d0e-a045-4d37b2d96be6#gh-dark-mode-only" width="25%">
83-
<img src="https://github.com/user-attachments/assets/3cbe03ce-9485-4e91-8aaa-a26297ee33d2#gh-light-mode-only" width="25%">
84-
<img src="https://github.com/user-attachments/assets/3a9962df-ebe9-40a8-9cf7-99717e870e9d#gh-dark-mode-only" width="25%">
99+
<table>
100+
<tr>
101+
<td><img src="https://github.com/user-attachments/assets/fba07491-de2f-4417-8944-1c3d4f91bc92#gh-light-mode-only" width="250"></td>
102+
<td><img src="https://github.com/user-attachments/assets/17d529d2-be3f-4d0e-a045-4d37b2d96be6#gh-dark-mode-only" width="250"></td>
103+
<td><img src="https://github.com/user-attachments/assets/3cbe03ce-9485-4e91-8aaa-a26297ee33d2#gh-light-mode-only" width="250"></td>
104+
<td><img src="https://github.com/user-attachments/assets/3a9962df-ebe9-40a8-9cf7-99717e870e9d#gh-dark-mode-only" width="250"></td>
105+
</tr>
106+
</table>
85107

86108
### Notification
87109

0 commit comments

Comments
 (0)