diff --git a/README.md b/README.md index 1ba257bf..becbcdf6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,116 @@ -This is a Kotlin Multiplatform project targeting Android, iOS. +

+

+ EvolveFit A gym tracking app built with Kotlin Multiplatform for Android and iOS. Track workouts , monitor progress , and achieve your fitness goals! +

+
+

-* `/composeApp` is for code that will be shared across your Compose Multiplatform applications. - It contains several subfolders: - - `commonMain` is for code that’s common for all targets. - - Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. - For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, - `iosMain` would be the right folder for such calls. +## Architecture +This project is based on a Kotlin Multiplatform (KMP) architecture with shared business logic between Android and iOS. -* `/iosApp` contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, - you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project. +## Technologies +> [!TIP] +> - KMP +> - cmp +> - Room Database +> - Koin +> - Coil +> - Ktor +> - Navigation 2(Type Safe) +## Features +### OnBoarding + +image -Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)… \ No newline at end of file + +### Authentication +register1 register2register3 + +### Home Screen +home + +> [!Note]| + +> - **Weakly Progress**: View your workout progress over the week. +> - +> - **Today's Nutrition**:Track your water intake and calorie consumption for the day. +> - +> - **Just For You**:Discover personalized workouts tailored to your goals. + + +### 🥗 Nutrition +nut1nut2nut3 + +[!Note] + +Nutrition: Overview of your daily nutrient and calorie progress. + +Add Meal: log your meals with amount of calories. + +Add Water: Stay hydrated by recording your daily water intake. + +Suggested Meals: meal recommendations. + +### Suggested Meals + + + + + + + + + + + +
Suggested Meals
+ meal +
+ +#### Meal Details: +> **_Displays all the details about the Meal_** + + + + + + + + + + + +
Meal details
+ mealde +
+ + + +### Workout: +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| workout1 |wor2 | work2 |work3| workout4 +### Profile Screen: +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +|more |mor2 | them |white + | + + +--- +## Installation +1- Clone the Repository +``` +git clone https://github.com/Cairo-Squad/EvolveFit.git +``` +2- open the project in android studio. + +3- Add the required parameters in `local.properties` file. + +4- Build and run the project on an emulator or physical device. + +## 👥 Contributors + + + diff --git a/img.png b/img.png new file mode 100644 index 00000000..228f96a6 Binary files /dev/null and b/img.png differ diff --git a/img_1.png b/img_1.png new file mode 100644 index 00000000..3285c936 Binary files /dev/null and b/img_1.png differ diff --git a/img_2.png b/img_2.png new file mode 100644 index 00000000..31f5d00c Binary files /dev/null and b/img_2.png differ