Skip to content

Latest commit

 

History

History
120 lines (90 loc) · 3.77 KB

README.md

File metadata and controls

120 lines (90 loc) · 3.77 KB

📱 TrackIt - Habit Tracking App

A modern Android application built with Jetpack Compose for tracking daily habits and building positive routines. TrackIt helps users establish and maintain healthy habits through intuitive tracking, statistics, and smart notifications.

✨ Features

  • 🎯 Habit Tracking: Create and track daily habits with customizable goals
  • 📊 Statistics & Analytics: Visual charts and progress tracking using MPAndroidChart
  • 🔔 Smart Notifications: Customizable reminders and habit notifications
  • 🎨 Modern UI: Beautiful Material Design 3 interface with Jetpack Compose
  • 📱 Multi-screen Navigation: Home, Statistics, and Settings screens
  • 💾 Local Storage: Persistent data storage using Room database
  • ⚡ Performance: Built with modern Android architecture components

🏗️ Architecture

  • UI Layer: Jetpack Compose with Material Design 3
  • Navigation: Navigation Compose for screen management
  • Data Layer: Room database with Kotlin Coroutines
  • Dependency Injection: Hilt for dependency management
  • Background Tasks: WorkManager for notifications
  • State Management: ViewModel with Compose integration

🛠️ Tech Stack

  • Language: Kotlin
  • UI Framework: Jetpack Compose
  • Database: Room with Kotlin Coroutines
  • DI: Hilt
  • Navigation: Navigation Compose
  • Charts: MPAndroidChart
  • Background Tasks: WorkManager
  • Time Picker: Sheets Compose Dialogs
  • Minimum SDK: API 26 (Android 8.0)
  • Target SDK: API 34 (Android 14)

📱 Screens

  • 🏠 Home: Main dashboard for habit tracking
  • 📊 Statistics: Progress charts and analytics
  • ⚙️ Settings: App configuration and preferences
  • ➕ Add Habit: Create new habits
  • 📋 Habit Detail: Detailed view of individual habits
  • 🎯 Onboarding: First-time user experience
  • ⚡ Splash: App launch screen

🚀 Getting Started

Prerequisites

  • Android Studio Hedgehog or later
  • Android SDK API 26+
  • Kotlin 1.9+
  • Gradle 8.0+

Installation

  1. Clone the repository

    git clone https://github.com/aayush256-sys/TrackIt.git
cd TrackIt

  2. Open in Android Studio

    • Open Android Studio
    • Select "Open an existing project"
    • Navigate to the TrackIt folder and select it

  3. Sync and Build

    • Wait for Gradle sync to complete
    • Build the project (Build → Make Project)

  4. Run on Device/Emulator

    • Connect an Android device or start an emulator
    • Click the "Run" button or press Shift+F10

🔧 Configuration

Permissions

The app requires the following permissions:

  • POST_NOTIFICATIONS: For habit reminders
  • RECEIVE_BOOT_COMPLETED: For notifications after device restart
  • SCHEDULE_EXACT_ALARM: For precise notification timing
  • USE_EXACT_ALARM: For exact alarm functionality

Build Configuration

  • Compile SDK: 34
  • Minimum SDK: 26
  • Target SDK: 34
  • Kotlin Version: 1.9+
  • Compose Compiler: 1.5.8

📊 Dependencies

Core Dependencies

  • Jetpack Compose BOM: 2024.02.00
  • Room: 2.6.1
  • Hilt: 2.48
  • Navigation Compose: 2.7.7
  • WorkManager: 2.9.0
  • MPAndroidChart: 3.1.0

UI Dependencies

  • Material 3: 1.2.0
  • Sheets Compose Dialogs: 1.2.1

🙏 Acknowledgments

TrackIt - Build better habits, one day at a time! 📈