Merge branch 'main' of github.com:fred-juma/iGymHealth into ui-layout

fred-juma · Nov 20, 2022 · c4fc269 · c4fc269
2 parents 29894b8 + 3e8d6a9
commit c4fc269
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,29 @@
 ## About
 
-This project is developed by a team of GADS (Google Africa Developer Scholarship) learners and mentors as requiremnt for the project phase of the learning.
+This project is developed by a team of GADS (Google Africa Developer Scholarship) learners and mentors as requirement for the project phase of the learning.
 
 The *iGymHealth* app inspiration is physical and mental fitness.
 
 The developers team seek to contribute to mental and physical well being of the app users by providing self guides that include phyical exercises, dieting tips and options, as well as mental wellness inspirations.
 
-It is our hope that through the app, many shall get inspiration and guidance on physicall and mentall wellness.
+It is our hope that through the app, many shall get inspiration and guidance on physical and mental wellness.
 
 ## Features
 * Physical strength exercises
 * Relaxation exercises
-* mental wellness inspiration quotes
-* In the future we hope to integrate the app to Google smart watch and Google fit products
+* Mental wellness inspiration quotes
+* In the future we hope to integrate the app to Google Smart watch and Google Fit Products
 
 ## Tools
 * Android Studio
 * Kotlin
 * Figma
-* Adobe xd
+* Adobe XD
 
+## Read The Docs
+
+[Navigation](docs/navigation.md)
+[Design](docs/main.md)
 
 ## How to install
 

diff --git a/docs/images/card_navigation.png b/docs/images/card_navigation.png
diff --git a/docs/main.md b/docs/main.md
@@ -0,0 +1,29 @@
+# App Design
+
+The components and libraries used in this app are used
+together to bring the desired results.
+
+## API
+
+The plan for the API is to use a free API to search for results
+and bring them to the user without leaving the app.
+
+## Offline & Online Features
+
+The app should be able to handle the connectivity issues and only
+activate some features when the online/offline condition is triggered.
+
+Online Features include:
+- Sync with online database.
+- Search for exercises & nutritient diets.
+
+Offline Features include:
+- Sync with local database.
+- Save workout records.
+- Setup nutritient diets.
+- Track progress or streak.
+
+## Save Favorites
+
+The app should allow the user to save favorite articles on a local database
+which in turn can be synchronised to the cloud.
diff --git a/docs/navigation.md b/docs/navigation.md
@@ -0,0 +1,21 @@
+# App Navigation.md
+
+The app structure is split into different parts in order to make it easier to work with.
+
+## Layout
+
+The app uses bottom bar navigation for the main UI.
+On the Home screen when the user clicks any of the cards. They are taken to a tab navigation UI.
+In that tab navigation UI there are fragments for that specific activity.
+
+## The Navigation
+
+The user can click any of the cards within the Home Fragment/Screen.
+The app will take the user to the relevant screen and run the activity called.
+In order for the user to return to the home screen they have to use the back button.
+This will be fixed in the future versions with deep linking, to allow the user to
+navigate to anywhere within the app from any point.
+
+An example of the navigation can be seen in the diagram below.
+
+<img src="images/card_navigation.png" />
diff --git a/images/assets/undraw_breakfast_psiw 1.png b/images/assets/undraw_breakfast_psiw 1.png
diff --git a/images/assets/undraw_healthy_habit_re_sy1e 1.png b/images/assets/undraw_healthy_habit_re_sy1e 1.png
diff --git a/images/assets/undraw_meditation_re_gll0(1) 1.png b/images/assets/undraw_meditation_re_gll0(1) 1.png
diff --git a/images/assets/undraw_office_snack_re_l162 1.png b/images/assets/undraw_office_snack_re_l162 1.png