An open API service indexing awesome lists of open source software.

https://github.com/fluttersmith/breakschedule


https://github.com/fluttersmith/breakschedule

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# ⏳ Break Reminder App

πŸ“Œ **Version:** 1.0.0
πŸ“… **Last Updated:** 2, 2025
πŸ‘€ **Author:** Ahmed Hamdy
πŸ”— **Repository:** [GitHub Link](https://github.com/FlutterSmith/BreakSchedule)

---

## πŸ“– Overview

**Break Reminder App** is a robust Flutter application designed to help users maintain productivity by reminding them to take regular breaks. Users can configure their preferred break duration, frequency, and notification type. With a modern, advanced UI and customizable options, the app provides live countdown timers for break sessions, displays random wellbeing tips, and supports push notifications to alert users when it’s time to take a break.

βœ… **Custom Break Schedules**
βœ… **Live Countdown Timer for Breaks**
βœ… **Push Notifications for Reminders**
βœ… **Random Wellbeing Tips & Animations**
βœ… **Advanced Customizable UI with Themes**

![Break Reminder App Demo](https://media.giphy.com/media/your-demo-url-here/giphy.gif)

---

## πŸš€ Features

### πŸ“… Schedule Configuration
βœ” **Customizable Break Length and Frequency:** Users can set their own break durations and intervals.
βœ” **Preloaded Schedules:** Choose from readymade schedules (like Pomodoro) or create a custom schedule.

### ⏰ Live Countdown Display
βœ” **Real-Time Timer:** The countdown screen updates in real‑time, showing days, hours, minutes, and seconds until the break ends.

### πŸ”” Push Notifications
βœ” **Scheduled Reminders:** Receive notifications to start and end your break sessions.

### 🌟 Wellbeing Tips
βœ” **Random Tips:** Each break session displays a random wellbeing tip (e.g., stretch, hydrate, relax your eyes).
βœ” **Animated Visuals:** Enjoy simple animations (via Lottie) to enhance your break experience.

### 🎨 Advanced UI & Theming
βœ” **Custom Themes:** Switch between light and dark modes, with a modern and responsive UI.

---

## πŸ› οΈ Tech Stack

| Technology | Purpose |
|------------------------------------|-------------------------------------------------------|
| **Flutter** | Cross‑platform mobile development |
| **Dart** | Primary programming language |
| **BloC Pattern** | State management and modular architecture |
| **flutter_local_notifications** | Scheduling and managing push notifications |
| **Provider** | Dependency injection and data sharing |
| **Lottie** | Displaying engaging animations |
| **sqflite** | Local persistence (if needed) |

---

## πŸš€ Installation

### πŸ“Œ Prerequisites
- βœ… **Flutter SDK** (Latest stable version)
- βœ… **Dart SDK** (Bundled with Flutter)
- βœ… **Android Studio / VS Code** (With Flutter extensions)

### πŸ“¦ Steps to Run

1️⃣ **Clone the Repository**
```
git clone https://github.com/yourusername/break_reminder_app.git
cd break_reminder_app
```
2️⃣ Install Dependencies
```
flutter pub get
```
3️⃣ Run the App
For mobile devices:
```
flutter run
```
For desktop (Windows, Linux, macOS):
```
flutter run -d windows # or -d linux, -d macos as applicable

```

πŸ“Œ Future Improvements
βœ… Integration with calendar events
βœ… Cloud synchronization for break schedules
βœ… Advanced customization (e.g., custom notification sounds, additional themes)
βœ… Support for multiple languages (localization)
βœ… Interactive wellbeing exercises

πŸ† Contributors
πŸ‘€ Your Name
GitHub: FlutterSmith

πŸ“ License
This project is licensed under the MIT License. See the LICENSE file for details.