Skip to content

Latest commit

ย 

History

24 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Aman Hydration Banner

๐Ÿ’ง A Smart Hydration Tracking Ecosystem built with Kotlin, Firebase & Wear OS

Aman helps users track daily water intake, stay hydrated with smart reminders, and sync seamlessly between Android & Wear OS โ€” all wrapped in a clean, modern UI.


GitHub stars GitHub forks GitHub issues


โœจ About Aman

Aman is a smart Android & Wear OS hydration tracking ecosystem designed to help users monitor daily water intake and build healthy hydration habits.

It combines real-time progress tracking, cloud synchronization with Firebase, and smart wearable integration โ€” all wrapped in a clean, modern Material Design 3 interface.


๐Ÿš€ Core Features

๐Ÿ“ฑ Mobile App (Android)

๐Ÿ’ง Smart Dashboard

  • Circular progress indicator
  • Real-time hydration tracking
  • Daily goal percentage display

๐Ÿ“Š Weekly Statistics

  • Interactive bar charts using MPAndroidChart
  • Visual comparison of 7-day hydration trends

๐ŸŽฏ Custom Goals

  • Personalized daily water target
  • Goal achievement animation using Lottie

๐Ÿ”” Smart Reminders

  • Built with WorkManager
  • Configurable interval (default: 2 hours)
  • Survives device reboot

๐Ÿ‘ค User Profile

  • Firebase Authentication (Email/Password)
  • Firestore cloud synchronization
  • Multi-language support (FR ๐Ÿ‡ซ๐Ÿ‡ท | EN ๐Ÿ‡ฌ๐Ÿ‡ง | AR ๐Ÿ‡ธ๐Ÿ‡ฆ RTL)

๐Ÿ“ค Data Export

  • Export hydration history to CSV
  • Local file storage

โŒš Wear OS App

๐Ÿ”ต Minimal Circular Interface

  • Optimized for small screens
  • Clean progress ring design

โž• Quick Add Button

  • Add 200ml instantly

๐ŸŽค Voice Input

  • Supports:
    • ๐Ÿ‡ซ๐Ÿ‡ท French
    • ๐Ÿ‡ฌ๐Ÿ‡ง English
    • ๐Ÿ‡ธ๐Ÿ‡ฆ Arabic

๐Ÿ”„ Real-Time Sync

  • Data Layer API
  • Instant sync between watch and mobile

๐Ÿง  Architecture

๐Ÿ—๏ธ Pattern

  • MVVM
  • Repository Pattern
  • Single Source of Truth
  • Offline-first with Room

๐Ÿ—‚๏ธ Modules

Aman/
โ”œโ”€โ”€ mobile/ โ†’ Android app
โ””โ”€โ”€ wear/ โ†’ Wear OS companion

๐Ÿ”ฅ Firebase Integration

  • Authentication
  • Firestore
  • Cloud Messaging (FCM)
  • Analytics

๐Ÿ’พ Local Persistence

  • Room Database
  • DataStore Preferences

๐Ÿ“Š Firestore Structure

users/{uid}
โ”œโ”€โ”€ displayName
โ”œโ”€โ”€ email
โ”œโ”€โ”€ dailyGoalMl
โ”œโ”€โ”€ birthDate
โ”œโ”€โ”€ locale
โ””โ”€โ”€ water_intake/{intakeId}
โ”œโ”€โ”€ amountMl
โ””โ”€โ”€ timestamp

๐ŸŽจ Design System

๐ŸŽจ Colors

  • Primary: #4A90E2
  • Secondary: #7ED321
  • Background: #F5F7FA

โœ๏ธ Typography

  • Headers: 24sp Bold
  • Body: 16sp Regular
  • Caption: 14sp

๐Ÿ“ UI Style

  • Material Design 3
  • Rounded cards (12โ€“16dp)
  • Soft shadows
  • Smooth animations

๐Ÿงฎ Hydration Tracking Logic

Daily Progress (%) = (Today Intake / Daily Goal) ร— 100

Example:
Goal = 2000ml
Intake = 1500ml

Progress = 75%

๐Ÿงฐ Technologies Used

๐Ÿ“ฑ Mobile App

Kotlin Material 3 MVVM Repository Room Firebase WorkManager MPAndroidChart Lottie Wearable DataStore

โŒš Wear OS App

Kotlin Wear UI Data Layer Voice

๐Ÿ” Security

๐Ÿ”’ Firestore Rules

match /users/{uid} {
  allow read, write: if request.auth.uid == uid;
}

๐Ÿงช Testing

./gradlew testDebugUnitTest
./gradlew connectedAndroidTest

๐Ÿ› ๏ธ Installation

1๏ธโƒฃ Clone the Repository

git clone https://github.com/<your-username>/Aman.git

2๏ธโƒฃ Open in Android Studio

  • File โ†’ Open โ†’ Select project folder

3๏ธโƒฃ Sync Gradle

  • Tools โ†’ Sync Project with Gradle Files

4๏ธโƒฃ Run

  • Select mobile or wear
  • Click โ–ถ Run

๐Ÿšง Challenges Faced

During development, several challenges were addressed:

  • ๐Ÿ”„ Real-time synchronization between Wear OS & Mobile

  • โ˜๏ธ Managing offline-first architecture with Firebase + Room

  • ๐Ÿ”” Reliable background reminders using WorkManager

  • ๐ŸŒ Proper RTL support for Arabic

  • ๐Ÿ“Š Optimizing chart performance

These improvements helped build a stable and scalable hydration ecosystem.

โญ Why Aman Stands Out

โœ… Complete Mobile + Wear Ecosystem

โœ… Real-Time Cloud Sync

โœ… Offline-first Architecture

โœ… Clean Material 3 UI

โœ… Multi-language Support

โœ… Production-ready MVVM structure

๐Ÿค Contributing

Contributions to this project are welcome! If you have suggestions, improvements, or bug fixes, please submit a pull request. Make sure to follow coding conventions and maintain consistent styles.

If you encounter issues or want to request a new feature, please open an issue in the repository with as much detail as possible.

Ways to Contribute

  • ๐Ÿ› Report Bugs - Found an issue? Let us know!
  • ๐Ÿ’ก Suggest Features - Have ideas? We'd love to hear them!
  • ๐Ÿ”ง Submit Pull Requests - Code contributions are welcome
  • ๐Ÿ“– Improve Documentation - Help make our docs better

Getting Started

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

โญ Support

If you like this project, don't forget to leave a โญ on GitHub. Thank you and happy coding! ๐Ÿš€


๐Ÿ“ฌ Stay in Touch

๐Ÿ‘จโ€๐Ÿ’ป Marouane Bouglace - Project Creator

Email GitHub LinkedIn


Thank you for visiting Aman! ๐Ÿ’ฌโœจ

About

A full-featured hydration tracking application with mobile and Wear OS companion apps, featuring Firebase integration, real-time synchronization, smart reminders, and beautiful visualizations.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages