👁️💧 Eye & Water Reminder App

A simple yet powerful reminder app to take care of your eye health and hydration needs. (Currently under review & available for testing only. If you wish to test this app, please share your email so I can send you an invite link.)

---

📱 About the App

Eye & Water Reminder is an Android application designed to remind users to:

• Take regular eye breaks (reducing digital strain).
• Drink enough water throughout the day.

The app is lightweight, simple, and perfect for health-conscious users.
This repository is mainly created for learning purposes and is open to contributions from developers worldwide.

---

🚀 Features

✅ Smart reminders for both eye breaks & water intake
✅ Customizable reminder frequency
✅ User-friendly UI with Material Design
✅ Lightweight & battery-efficient
✅ Free & Open Source
✅ Perfect for Android learning (Jetpack Compose, MVVM, Room, Clean Architecture, etc.)

---

🛠 Tech Stack

• Language: Kotlin
• Architecture: MVVM (Model-View-ViewModel) with Clean Architecture
• UI Toolkit: Jetpack Compose
• Local Storage: Room Database
• Dependency Injection: Hilt
• Async & Reactive: Coroutines & Flow
• Background Tasks: WorkManager
• Static Analysis: Detekt (Code quality & lint checks)
• Unit Testing: JUnit + JaCoCo (Code coverage reports)
• CI/CD: GitHub Actions (Automated build, unit tests, and linting pipeline)

---

⚙️ CI/CD Pipeline

This project integrates GitHub Actions to ensure high code quality and reliability.
The pipeline includes:

• 🔍 Detekt Analysis → Automated Kotlin static code analysis for clean, maintainable code.
• 🏗 Build Verification → Ensures that every commit/PR successfully compiles the Android project.
• ✅ Unit Test Execution → Runs unit tests with coverage checks to validate correctness.

These checks are triggered automatically on every pull request to maintain project quality.

---

com.alpha.myeyecare/ 
│ 
├── common/                          
│   ├── constants/ 
│   │   ├── AppDestinations.kt
│   │   └── ReminderTypes.kt 
│   └── utils/ 
│       ├── ExtensionFunctions.kt            
│       └── UtilFunctions.kt         
│ 
├── data/                            
│   ├── local/                       
│   │   ├── converters/ 
│   │   │   ├── Converters.kt 
│   │   ├── dao/ 
│   │   │   ├── ReminderDao.kt  
│   │   ├── entities/ 
│   │   │   ├── Reminder.kt  
│   │   └── ReminderDatabase.kt 
│   │ 
│   └── repository/                 # Repository implementation
│       ├── SuggectionRepositoryImpl.kt  
│       └── ReminderRepositoryImpl.kt  
│  
├── di/                             
│   ├── AppModule.kt 
│   ├── DatabaseModule.kt
│   └── RemoteModule.kt 
│
├── domain/                         
│   ├── model/ 
│   │   ├── DaysOfWeek.kt 
│   │   ├── ReminderDetails.kt 
│   │   ├── ReminderFrequency.kt 
│   │   └── Suggestion.kt 
│   │ 
│   ├── repository/                 # Abstract repository interfaces 
│   │   ├── ReminderRepository.kt 
│   │   └── SuggestionRepository.kt 
│   │ 
│   └── usecase/                   
│       ├── CheckReminderStatusUseCase.kt 
│       ├── GetReminderDetailsUserCase.kt 
│       ├── SaveReminderUseCase.kt  
│       └── SaveSuggestionsUseCase.kt 
│ 
├── presentation/                  
│   ├── navigation/ 
│   │    └── NavGraph.kt  
│   └── ui/                   
│       ├── common/ 
│       │   └── CommonUI.kt
│       ├── detailsScreen/ 
│       │   ├── SetupReminderScreen.kt
│       │   └── SetupReminderViewModel.kt
│       ├── home/ 
│       │   └── HomeScreen.kt 
│       ├── splash/ 
│       │   ├── SplashScreen.kt
│       │   └── SplashViewModel.kt 
│       ├── suggestion/ 
│       │   ├── SuggestionSubmissionViewModel.kt 
│       │   └── UserSuggestionScreen.kt
│       ├── theme/ 
│       │   ├── Color.kt 
│       │   ├── Theme.kt 
│       │   └── Type.kt 
│       └── userPermission.kt  
├── Worker/                  
│   ├── ReminderScheduler.kt
│   └── ReminderWorker.kt 
├── MainActivity.kt                   
└── MyApplication.kt                 

---

📸 Screenshots

Home Screen	Reminder Screen	Settings

---

🤝 Contributing

We welcome contributions! 🚀
If you’d like to add new features, improve UI/UX, or optimize performance:

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

Every PR will go through automated build, lint, and test checks before merging.

---

👨‍💻 Developers

• Shubham Gadekar (Developer)
• Nitin Tyagi (Developer)
• Open to all contributors! Add yourself here via PR.

---

🎯 Why Open Source?

This project is for learning purposes. Developers can explore:

• Jetpack Compose UI development
• MVVM with Kotlin
• Dependency Injection with Hilt
• Room database
• WorkManager background scheduling
• Static analysis & linting with Detekt
• CI/CD automation with GitHub Actions

---

📥 Download

Get it now on the Play Store:
👉 Download from Play Store

---

⭐ Support

If you find this project helpful, don’t forget to star ⭐ the repo and share it with others!