ofalvai/habitbuilder

A simple and clean app with the right tools to keep track of habits and understand progress.

Habit Builder

Motivation

I needed a simple and minimal habit tracking app, so I decided to create my own.

This project is also a testing ground for new technologies I'd like to explore.

Features

• Keep track of new habits and see your progress
• Statistics: aggregate and per-habit stats
  • Per-habit: completion rate, weekly and overall count, streaks
  • Overall: calendar heatmap, top habits, top days for habits
• Customizable habit list layout, reorderable list
• All data is persisted on-device in a database
• Export, import, archiving of old items

🛠 Built with

• Compose-only UI:
  • Based on Material3, supports dynamic color
  • Light and dark theme
  • Smooth and delightful animations
  • No AppCompat dependency, single Activity
• Room: for storing data locally
• Kotlin Coroutines + Flow: for async operations
• Testing:
  • Unit tests for most of the business logic (ViewModels, mappings, etc.)
  • Instrumented tests for DB operations
  • UI tests for some Compose screens
  • Kotlin Flow testing with Turbine
• Showkase: UI component browser in debug builds
• Other interesting bits and integrations:
  • Modular codebase according to best practices
  • Gradle convention plugins for configuring modules
  • Licensee: 3rd party dependency validation, license report JSON for the Licenses screen
  • Ruler: a Gradle plugin that measures app size and libraries contributing to it
  • Gradle version catalog
  • Renovate: Automating dependency update PRs (works with Gradle version catalogs!)
  • Gradle dependency analysis: For automatically detecting unused dependencies and other common mistakes

Development

Useful Gradle tasks

• analyzeReleaseBundle: Run Spotify Ruler
• licenseeRelease: Run license check and generate app/build/reports/licensee/release/artifacts.json, which should be copied over to assets/licenses.json for the Licenses screen
• assembleRelease -Phabittracker.enableComposeCompilerReports=true: Write Compose compiler metrics to $module/build/compose_metrics
• buildHealth: Run dependency analysis (looking for unused dependencies, incorrect module structure)

License

   Copyright 2023 Olivér Falvai

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.