Skip to content

hashi173/Habit-Flare

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ”₯ HabitFlare

A minimalist, streak-based habit tracker

Simple. Beautiful. Effective.

React TypeScript Tailwind CSS Capacitor License


Features

Core Features

  • Habit Tracking - Track daily habits with beautiful visual cards
  • Streak Counter - Stay motivated with fire emoji streak indicators
  • Weekly Calendar - Quick navigation with visual completion status
  • Statistics Dashboard - Analyze your habits with completion rates and charts
  • Customizable - Choose from 28+ icons and 18 vibrant colors
  • Reminders - Set custom alarm times for each habit
  • Flexible Scheduling - Select specific days for each habit

Design & Experience

  • Dark Mode - Eye-friendly theme for day and night
  • Mobile-First - Optimized for Android devices
  • Offline-First - Works completely offline, no internet needed
  • Privacy-Focused - All data stored locally on your device
  • Lightning Fast - Smooth animations and instant responses
  • Modern UI - Clean, minimalist design with glassmorphism effects

Screenshots

Main View

Home Screen

Track your daily habits with a beautiful card interface. See your active streaks at a glance.

Add Habit View

Add Habit Screen

Create new habits with custom icons, colors, and schedules. Set reminders to stay on track.

Calendar History

Calendar View

Visualize your habit completion with a color-coded heatmap calendar.

Statistics Dashboard

Statistics Screen

Track your progress with detailed completion rates and habit breakdowns.

Settings

Settings Screen

Customize your experience with dark mode and manage your data.

Dark Theme

Dark Mode

Beautiful dark theme for comfortable evening tracking.


Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v16 or higher)
  • npm or yarn
  • Android Studio (for Android builds)
  • JDK 17 (for Android builds)

Installation

For Android Mobile Phone

  1. Download the apk file form Release
  2. Install to your phone

For PC

  1. Clone the repository
git clone https://github.com/yourusername/habitflare.git
cd habitflare
  1. Install dependencies
npm install
  1. Run development server
npm run dev

The app will open at http://localhost:5173


Building for Android

Setup Android Environment

  1. Install Android Studio from developer.android.com

  2. Set up environment variables:

# Add to your system environment variables
ANDROID_HOME=C:\Users\YourName\AppData\Local\Android\Sdk
JAVA_HOME=C:\Program Files\Java\jdk-17

# Add to Path
%ANDROID_HOME%\platform-tools
%ANDROID_HOME%\tools
%JAVA_HOME%\bin

Build APK

Debug APK (for testing)

# 1. Build web assets
npm run build

# 2. Sync to Android
npx cap sync android

# 3. Open in Android Studio
npx cap open android

# 4. In Android Studio: Build > Build Bundle(s) / APK(s) > Build APK(s)

APK location: android/app/build/outputs/apk/debug/app-debug.apk

Release APK (for distribution)

  1. Generate keystore (first time only):
keytool -genkey -v -keystore habitflare.keystore -alias habitflare -keyalg RSA -keysize 2048 -validity 10000
  1. Move keystore to android/app/

  2. Create android/keystore.properties:

storePassword=YourPassword
keyPassword=YourPassword
keyAlias=habitflare
storeFile=habitflare.keystore
  1. Build release APK:
cd android
./gradlew assembleRelease

APK location: android/app/build/outputs/apk/release/app-release.apk


Tech Stack

Technology Purpose
React 18 UI framework
TypeScript Type safety
Tailwind CSS Styling
Capacitor Native Android wrapper
Lucide React Icon library
Vite Build tool
LocalStorage Data persistence

Project Structure

habitflare/
β”œβ”€β”€ android/              # Capacitor Android project
β”œβ”€β”€ assets/              # Images and icons
β”œβ”€β”€ components/          # React components
β”‚   β”œβ”€β”€ BottomNav.tsx   # Bottom navigation
β”‚   └── HabitCard.tsx   # Habit display card
β”œβ”€β”€ views/              # Main screens
β”‚   β”œβ”€β”€ Home.tsx        # Home screen with habit list
β”‚   β”œβ”€β”€ AddHabit.tsx    # Create new habit
β”‚   β”œβ”€β”€ CalendarView.tsx # Calendar & statistics
β”‚   └── Settings.tsx    # App settings
β”œβ”€β”€ utils/              # Utility functions
β”‚   └── dateUtils.ts    # Date manipulation helpers
β”œβ”€β”€ App.tsx             # Main app component
β”œβ”€β”€ constants.tsx       # Icons and colors config
β”œβ”€β”€ types.ts            # TypeScript interfaces
└── index.tsx           # Entry point

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A simple Habit Tracking app for Android inspired by Habit Streak.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors