Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ofalvai/HabitBuilder
A simple and clean app with the right tools to keep track of habits and understand progress.
https://github.com/ofalvai/HabitBuilder
android habit-tracking habits jetpack-compose kotlin
Last synced: about 2 months ago
JSON representation
A simple and clean app with the right tools to keep track of habits and understand progress.
- Host: GitHub
- URL: https://github.com/ofalvai/HabitBuilder
- Owner: ofalvai
- License: apache-2.0
- Created: 2020-12-24T12:10:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T21:40:12.000Z (about 2 months ago)
- Last Synced: 2024-08-01T21:49:22.646Z (about 2 months ago)
- Topics: android, habit-tracking, habits, jetpack-compose, kotlin
- Language: Kotlin
- Homepage:
- Size: 3.01 MB
- Stars: 162
- Watchers: 4
- Forks: 7
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Habit Builder [](https://app.bitrise.io/app/956ea5e751ec6be4)
[
](https://play.google.com/store/apps/details?id=com.ofalvai.habittracker) [
](https://apt.izzysoft.de/fdroid/index/apk/com.ofalvai.habittracker/)
| | | | |
|---|---|---|---|
|  |  |  |  |
## 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](https://developer.android.com/jetpack/compose) UI:
- Based on Material3, supports dynamic color
- Light and dark theme
- Smooth and delightful animations
- No AppCompat dependency, single Activity
- [Room](https://developer.android.com/training/data-storage/room): for storing data locally
- [Kotlin Coroutines](https://kotlinlang.org/docs/coroutines-overview.html) + [Flow](https://kotlinlang.org/docs/flow.html): 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](https://github.com/cashapp/turbine)
- [Showkase](https://github.com/airbnb/Showkase): UI component browser in debug builds
- Other interesting bits and integrations:
- Modular codebase according to best practices
- [Gradle convention plugins](https://github.com/ofalvai/HabitTracker/tree/main/build-logic) for configuring modules
- [Licensee](https://github.com/cashapp/licensee): 3rd party dependency validation, license report JSON for the Licenses screen
- [Ruler](https://github.com/spotify/ruler): a Gradle plugin that measures app size and libraries contributing to it
- [Gradle version catalog](https://github.com/ofalvai/HabitTracker/blob/main/gradle/libs.versions.toml)
- [Renovate](https://github.com/ofalvai/HabitTracker/issues/10): Automating dependency update PRs (works with Gradle version catalogs!)
- [Gradle dependency analysis](https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin): 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.
```