Skip to content

Update README.md #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abdallahFc merged 1 commit into from
Sep 4, 2025
Merged

Update README.md #413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
347 changes: 244 additions & 103 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,116 +1,257 @@
<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>

## Architecture
This project is based on a Kotlin Multiplatform (KMP) architecture with shared business logic between Android and iOS.

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


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

#### 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>
<div align="center">

![EvolveFit Banner](https://github.com/user-attachments/assets/a05dd70d-5fa4-46e7-b1cf-ad426dd38e30)

**🏋️ A comprehensive gym tracking app built with Kotlin Multiplatform**
*Track workouts • Monitor progress • Achieve your fitness goals*

### 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" />
|
[![Kotlin](https://img.shields.io/badge/Kotlin-Multiplatform-7F52FF?style=for-the-badge&logo=kotlin)](https://kotlinlang.org)
[![Compose](https://img.shields.io/badge/Compose-Multiplatform-4285F4?style=for-the-badge&logo=jetpackcompose)](https://www.jetbrains.com/compose/)
[![License](https://img.shields.io/badge/License-MIT-00C851?style=for-the-badge)](LICENSE)
[![Contributors](https://img.shields.io/badge/Contributors-Welcome-FF6B6B?style=for-the-badge)](https://github.com/Cairo-Squad/EvolveFit/graphs/contributors)

</div>

---
## Installation
1- Clone the Repository

## 🏗️ Architecture & Technology Stack

<div align="center">

**Built with modern technologies for optimal performance**

</div>

### 🔧 Core Technologies
```
🎯 Kotlin Multiplatform (KMP) 📱 Compose Multiplatform
🗄️ Room Database 🔗 Koin Dependency Injection
🖼️ Coil Image Loading 🌐 Ktor Networking
🧭 Type-Safe Navigation 2
```

---

## ✨ Features Overview

### 🚀 **OnBoarding Experience**
<div align="center">
<img width="300" height="600" alt="OnBoarding Screen" src="https://github.com/user-attachments/assets/f0351615-99cd-4202-9f9b-2622c7917d02" />
</div>

### 🔐 **Seamless Authentication**
<div align="center">
<img width="250" height="540" alt="Registration Step 1" src="https://github.com/user-attachments/assets/755ed781-e893-457f-ab76-9a3582237834" />
<img width="250" height="540" alt="Registration Step 2" src="https://github.com/user-attachments/assets/04af8d4b-b00c-4c84-b9b5-dacf7fd44faf" />
<img width="250" height="540" alt="Registration Step 3" src="https://github.com/user-attachments/assets/72c1126c-b126-4a88-954e-ba44307ee784" />
</div>

### 🏠 **Smart Home Dashboard**
<div align="center">
<img width="300" height="600" alt="Home Screen" src="https://github.com/user-attachments/assets/1405881a-5f36-4dcb-9f04-2ebc75f9ed4b" />
</div>

> **🎯 Key Features:**
> - **📊 Weekly Progress** - Visualize your workout journey over time
> - **🍎 Today's Nutrition** - Monitor water intake and calorie consumption
> - **✨ Personalized Workouts** - AI-curated routines tailored to your goals

---

## 🥗 Nutrition Tracking

<div align="center">

**Complete nutrition management at your fingertips**

<img width="250" height="540" alt="Nutrition Overview" src="https://github.com/user-attachments/assets/4b1dfa38-0593-444d-8515-7cdd153a06f5" />
<img width="250" height="540" alt="Add Meal" src="https://github.com/user-attachments/assets/59ef9705-181e-4d17-ae85-425dd410163f" />
<img width="250" height="540" alt="Water Tracking" src="https://github.com/user-attachments/assets/e14967c6-2d04-4885-8526-5594bd1e4a93" />

</div>

### 🍽️ **Smart Meal Suggestions**

<div align="center">

<img width="300" height="600" alt="Suggested Meals" src="https://github.com/user-attachments/assets/6f91196e-70db-4151-886d-f40c8ce81a7d" />

**📋 Detailed Meal Information**

<img width="300" height="600" alt="Meal Details" src="https://github.com/user-attachments/assets/408e67c3-a73d-4201-9df4-0da81b5dfb15" />

</div>

---

## 💪 Workout Management

<div align="center">

**Your personal trainer in your pocket**

</div>

<table align="center">
<tr>
<td align="center">
<img width="200" height="400" alt="Workout Home" src="https://github.com/user-attachments/assets/18a2acf4-9858-4361-8511-493e33703247" />
<br><b>📋 Workout Plans</b>
</td>
<td align="center">
<img width="200" height="400" alt="Exercise List" src="https://github.com/user-attachments/assets/b6e6b621-55e2-45e2-b868-43e38abe110d" />
<br><b>🏃 Exercise Library</b>
</td>
<td align="center">
<img width="200" height="400" alt="Exercise Details" src="https://github.com/user-attachments/assets/06d15897-bd7f-4446-922d-c934ba7c13ec" />
<br><b>📖 Exercise Guide</b>
</td>
</tr>
<tr>
<td align="center">
<img width="200" height="400" alt="Workout Progress" src="https://github.com/user-attachments/assets/78c19172-7618-4f32-aaec-eb1ce8b922c2" />
<br><b>📈 Progress Tracking</b>
</td>
<td align="center">
<img width="200" height="400" alt="Workout Timer" src="https://github.com/user-attachments/assets/597e3a1a-f190-46f7-883b-51dcd69e1ba6" />
<br><b>⏱️ Workout Timer</b>
</td>
</tr>
</table>

---

## 👤 Profile & Customization

<div align="center">

**Personalize your fitness experience**

</div>

<table align="center">
<tr>
<td align="center">
<img width="200" height="400" alt="Profile Menu" src="https://github.com/user-attachments/assets/a3c2ece1-a26c-42e0-b986-2eb0b582bff1" />
<br><b>⚙️ Settings Hub</b>
</td>
<td align="center">
<img width="200" height="400" alt="Profile Details" src="https://github.com/user-attachments/assets/fd3eca99-440c-4b84-8f67-4dd958667366" />
<br><b>👤 Profile Info</b>
</td>
<td align="center">
<img width="200" height="400" alt="Dark Theme" src="https://github.com/user-attachments/assets/22e10a4c-5cb1-404a-9299-aed19e95fb88" />
<br><b>🌙 Dark Theme</b>
</td>
<td align="center">
<img width="200" height="400" alt="Light Theme" src="https://github.com/user-attachments/assets/860e23d5-e406-4f5c-a3fe-bb4ea001f650" />
<br><b>☀️ Light Theme</b>
</td>
</tr>
</table>

---

## 🚀 Getting Started

<div align="center">

**Ready to transform your fitness journey?**

</div>

### 📥 **Installation Steps**

```bash
# 1️⃣ Clone the repository
git clone https://github.com/Cairo-Squad/EvolveFit.git

# 2️⃣ Open in Android Studio
# Launch Android Studio and open the project

# 3️⃣ Configure environment
# Add required parameters in local.properties file

# 4️⃣ Build and run
# Deploy to emulator or physical device
```

---

## 🤝 Join Our Community

<div align="center">

**Help us make fitness accessible for everyone!**

[![Contributors Welcome](https://img.shields.io/badge/Contributors-Welcome-00C851?style=for-the-badge&logo=github)](CONTRIBUTING.md)
[![Good First Issues](https://img.shields.io/badge/Good_First_Issues-Available-4285F4?style=for-the-badge&logo=github)](https://github.com/Cairo-Squad/EvolveFit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
[![Discord](https://img.shields.io/badge/Join_Our-Discord-7289DA?style=for-the-badge&logo=discord)](https://discord.gg/your-discord)

</div>

### 🛠️ **How to Contribute**

<div align="center">

```mermaid
graph LR
A[🍴 Fork] --> B[🌿 Branch]
B --> C[💾 Commit]
C --> D[📤 Push]
D --> E[🎯 PR]
style A fill:#FF6B6B
style B fill:#4ECDC4
style C fill:#45B7D1
style D fill:#96CEB4
style E fill:#FFEAA7
```
2- open the project in android studio.

3- Add the required parameters in `local.properties` file.
</div>

1. **🍴 Fork** the repository to your GitHub account
2. **🌿 Create** your feature branch (`git checkout -b feature/amazing-feature`)
3. **💾 Commit** your changes with descriptive messages
4. **📤 Push** to your forked repository
5. **🎯 Open** a Pull Request with detailed description

---

## 👥 Meet Our Team

<div align="center">

[![Contributors](https://contrib.rocks/image?repo=Cairo-Squad/EvolveFit)](https://github.com/Cairo-Squad/EvolveFit/graphs/contributors)

**💖 Made with passion by the Cairo Squad**
*Dedicated developers revolutionizing fitness technology*

</div>

---

## 🌟 Show Your Support

<div align="center">

**Love EvolveFit? Show us some love!**

[![GitHub stars](https://img.shields.io/github/stars/Cairo-Squad/EvolveFit?style=for-the-badge&logo=github&color=FFD700)](https://github.com/Cairo-Squad/EvolveFit)
[![GitHub forks](https://img.shields.io/github/forks/Cairo-Squad/EvolveFit?style=for-the-badge&logo=github&color=32CD32)](https://github.com/Cairo-Squad/EvolveFit/network)
[![GitHub watchers](https://img.shields.io/github/watchers/Cairo-Squad/EvolveFit?style=for-the-badge&logo=github&color=1E90FF)](https://github.com/Cairo-Squad/EvolveFit/watchers)

**⭐ Star this repository if it helped you on your fitness journey!**

<br>

*🚀 Evolving fitness technology, one commit at a time*

<br>

4- Build and run the project on an emulator or physical device.
[![Built with Love](https://img.shields.io/badge/Built_with-❤️_&_☕-FF6B6B?style=flat-square)](https://github.com/Cairo-Squad/EvolveFit)
[![Powered by Kotlin](https://img.shields.io/badge/Powered_by-Kotlin_Multiplatform-7F52FF?style=flat-square&logo=kotlin)](https://kotlinlang.org)
[![Made in Cairo](https://img.shields.io/badge/Made_in-🏛️_Cairo-F39C12?style=flat-square)](https://en.wikipedia.org/wiki/Cairo)

## 👥 Contributors
<a href="https://github.com/Cairo-Squad/EvolveFit/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Cairo-Squad/EvolveFit" />
</a>
</div>