/streaker

Primary LanguageDartMIT LicenseMIT

Project logo

Streaker

Status License


📝 Table of Contents

🧐 About

Streaker is a habit tracking app built with Flutter, Riverpod, and Firebase. It allows users to create and track their daily habits, view their streak counts, and receive reminders to help them stay on track.

  • Habit Creation: Users can create new habits and set their desired frequency (daily, weekly, or custom).
  • Habit Tracking: Users can mark habits as complete or missed for each day.
  • Streak Tracking: The app keeps track of users' current and longest streaks for each habit.
  • Reminders: Users can set reminders for their habits to help them stay consistent.
  • Firebase Integration: User data is securely stored in Firebase, allowing for cross-device synchronization.
  • Riverpod State Management: The app utilizes Riverpod for efficient and scalable state management.

🏁 Getting Started

To run the app locally, follow these steps:

  1. Make sure you have Flutter installed on your machine. You can find the installation instructions here.
  2. Clone this repository: git clone https://github.com/niteshsh4rma/streaker.git
  3. Navigate to the project directory: cd streaker
  4. Run flutter pub get to install the required dependencies.
  5. Create a new Firebase project and enable the required services (Authentication, Firestore, etc.).
  6. Copy the Firebase configuration files (google-services.json for Android, GoogleService-Info.plist for iOS) to their respective directories (android/app and ios/Runner).
  7. Run flutter run to launch the app on your connected device or emulator.

⛏️ Built Using

✍️ Authors

🎉 Acknowledgements

  • Hat tip to anyone whose code was used
  • Inspiration
  • References