zeba_academy_study_timer 1.0.0

Pomodoro study timer with streak tracking, XP rewards and analytics.

zeba_academy_study_timer

A powerful Flutter study productivity toolkit that provides Pomodoro timers, study streak tracking, XP-based rewards, goal-based sessions, and session analytics.

This package helps developers easily add gamified study tracking systems into Flutter apps for students, e-learning platforms, productivity apps, and study planners.

---

✨ Features

• ⏱ Pomodoro Timer – Simple configurable focus timer
• 🔥 Study Streak Tracking – Track consecutive study days
• 🎯 Goal-Based Sessions – Attach study goals to each session
• ⭐ XP & Reward System – Gamified learning progress
• 📊 Session Analytics – Analyze total study time and averages
• 🧩 Easy Integration – Simple API for Flutter apps

---

📦 Installation

Add the package to your pubspec.yaml.

dependencies:
  zeba_academy_study_timer: ^1.0.0

Then run:

flutter pub get

---

🚀 Import

import 'package:zeba_academy_study_timer/zeba_academy_study_timer.dart';

---

⏱ Pomodoro Timer

The Pomodoro timer helps users focus on study sessions.

Example

final timer = PomodoroTimer(
  workMinutes: 25,
  breakMinutes: 5,
);

timer.onTick = (seconds) {
  print("Remaining: $seconds");
};

timer.onFinish = () {
  print("Session completed!");
};

timer.start();

---

🔥 Study Streak Tracking

Track how many days the user studies consecutively.

final streak = StudyStreak();

streak.recordStudy(DateTime.now());

print(streak.currentStreak);

---

⭐ XP & Reward System

Gamify study sessions using XP points.

final rewards = XPRewardSystem();

rewards.addSessionXP(30);

print("Total XP: ${rewards.totalXP}");
print("Level: ${rewards.level}");

---

🎯 Goal Based Study Sessions

Each session can store a study goal.

final session = StudySession(
  startTime: DateTime.now(),
  endTime: DateTime.now().add(Duration(minutes: 25)),
  durationMinutes: 25,
  goal: "Learn Flutter State Management",
);

---

📊 Session Analytics

Analyze study performance.

final analytics = SessionAnalytics(sessions);

print("Total Sessions: ${analytics.totalSessions}");
print("Total Study Time: ${analytics.totalStudyTime}");
print("Average Minutes: ${analytics.averageSessionMinutes}");

---

🧠 Study Timer Manager

Manage sessions, streaks, and rewards together.

final manager = StudyTimerManager();

manager.completeSession(
  start: DateTime.now(),
  end: DateTime.now().add(Duration(minutes: 25)),
  goal: "Math Revision",
);

print(manager.sessions.length);
print(manager.streak.currentStreak);
print(manager.rewards.totalXP);

---

📱 Example App

Run the example application included with the package.

cd example
flutter run

---

📸 Screenshots

Place screenshots inside a screenshots folder in the root project.

screenshots/
├── timer.png
├── streak.png
├── analytics.png
├── rewards.png

Then reference them in the README:

![Pomodoro Timer](screenshots/timer.png)

![Study Streak](screenshots/streak.png)

![Session Analytics](screenshots/analytics.png)

![Rewards System](screenshots/rewards.png)

---

🧪 Running Tests

Run tests using:

flutter test

---

📂 Project Structure

lib/
 ├── zeba_academy_study_timer.dart
 └── src
     ├── models
     │    └── study_session.dart
     ├── timer
     │    └── pomodoro_timer.dart
     ├── streak
     │    └── study_streak.dart
     ├── rewards
     │    └── xp_reward_system.dart
     ├── analytics
     │    └── session_analytics.dart
     └── manager
          └── study_timer_manager.dart

---

🎯 Use Cases

This package is perfect for:

• 📚 Study planner apps
• 🧑‍🎓 Student productivity apps
• 📖 E-learning platforms
• ⏳ Focus timer apps
• 🎮 Gamified learning systems

---

🤝 Contributing

Contributions are welcome!

1. Fork the repository
2. Create a new feature branch
3. Commit your changes
4. Submit a pull request

---

📄 License

This project is licensed under the GPL License.

---

👨‍💻 Author

Developed by Zeba Academy to help students build better study habits through gamification and productivity tools.