Feat/make readme

README.md

@@ -1,14 +1,116 @@
-This is a Kotlin Multiplatform project targeting Android, iOS.
+<p align="center">
+    <p align="center">
+   EvolveFit A gym tracking app built with Kotlin Multiplatform for Android and iOS. Track workouts , monitor progress , and achieve your fitness goals!
+  </p>
+  <br>
+</p>
 
-* `/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
+
+<img width="384" height="776" alt="image" src="https://github.com/user-attachments/assets/f0351615-99cd-4202-9f9b-2622c7917d02" />
 
-Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…
+
+### Authentication
+<img width="323" height="720" alt="register1" src="https://github.com/user-attachments/assets/755ed781-e893-457f-ab76-9a3582237834" /> <img width="323" height="720" alt="register2" src="https://github.com/user-attachments/assets/04af8d4b-b00c-4c84-b9b5-dacf7fd44faf" /><img width="323" height="720" alt="register3" src="https://github.com/user-attachments/assets/72c1126c-b126-4a88-954e-ba44307ee784" />
+
+### Home Screen
+<img width="323" height="720" alt="home" src="https://github.com/user-attachments/assets/1405881a-5f36-4dcb-9f04-2ebc75f9ed4b" />
+
+> [!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
+<img width="323" height="720" alt="nut1" src="https://github.com/user-attachments/assets/4b1dfa38-0593-444d-8515-7cdd153a06f5" /><img width="323" height="720" alt="nut2" src="https://github.com/user-attachments/assets/59ef9705-181e-4d17-ae85-425dd410163f" /><img width="323" height="720" alt="nut3" src="https://github.com/user-attachments/assets/e14967c6-2d04-4885-8526-5594bd1e4a93" />
+
+[!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
+<table>
+  <thead>
+    <tr>
+      <th>Suggested Meals</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+    <img width="323" height="720" alt="meal" src="https://github.com/user-attachments/assets/6f91196e-70db-4151-886d-f40c8ce81a7d" />
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+#### Meal Details:
+> **_Displays all the details about the Meal_**
+<table>
+  <thead>
+    <tr>
+      <th> Meal details </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+    <img width="323" height="720" alt="mealde" src="https://github.com/user-attachments/assets/408e67c3-a73d-4201-9df4-0da81b5dfb15" />
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+
+
+### Workout:
+|                                                                                                                    |                                                                                                                    |                                                                                                                       |                                                                                                                             |                                                                                                                              |
+|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+| <img width="323" height="720" alt="workout1" src="https://github.com/user-attachments/assets/18a2acf4-9858-4361-8511-493e33703247" /> |<img width="323" height="720" alt="wor2" src="https://github.com/user-attachments/assets/b6e6b621-55e2-45e2-b868-43e38abe110d" /> | <img width="323" height="720" alt="work2" src="https://github.com/user-attachments/assets/06d15897-bd7f-4446-922d-c934ba7c13ec" /> |<img width="323" height="720" alt="work3" src="https://github.com/user-attachments/assets/78c19172-7618-4f32-aaec-eb1ce8b922c2" />| <img width="323" height="720" alt="workout4" src="https://github.com/user-attachments/assets/597e3a1a-f190-46f7-883b-51dcd69e1ba6" />
+### Profile Screen:
+|                                                                                                                        |                                                                                                                          |                                                                                                                              |                                                                                                                              |
+|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+|<img width="323" height="720" alt="more" src="https://github.com/user-attachments/assets/a3c2ece1-a26c-42e0-b986-2eb0b582bff1" /> |<img width="323" height="720" alt="mor2" src="https://github.com/user-attachments/assets/fd3eca99-440c-4b84-8f67-4dd958667366" /> | <img width="323" height="720" alt="them" src="https://github.com/user-attachments/assets/22e10a4c-5cb1-404a-9299-aed19e95fb88" /> |<img width="323" height="720" alt="white" src="https://github.com/user-attachments/assets/860e23d5-e406-4f5c-a3fe-bb4ea001f650" />
+ |
+
+
+---
+## 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
+<a href="https://github.com/Cairo-Squad/EvolveFit/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Cairo-Squad/EvolveFit" />
+</a>