ofalvai / habitbuilder Goto Github PK

131.0 4.0 4.0 3 MB

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

License: Apache License 2.0

Kotlin 99.87% Just 0.13%

android habit-tracking habits jetpack-compose kotlin

habitbuilder's Introduction

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.

habitbuilder's People

Contributors

Stargazers

Watchers

Forkers

shivarchit tripathi-dev gelma superyoko

habitbuilder's Issues

add a skip button and more

a skip button is useful to not lose your streak if you can't do a habit for reasons not realeted to you, also you can add a single day task system, a scheduling system to schedule a habit for specific day of the week and a compilation tracker to complete an habit (example: 20 page of a book)

[FR] Respect system haptics setting

Budget devices tend to have a cheap vibrator which feels awful when one tries to make haptic effects with it, as compared to the actuators on Pixels and Galaxy S-series; it would be cool for the app to respect the system "Vibration and Haptics/Touch feedback" setting, for those who have disabled haptics due to this, or perhaps because they find haptics distracting

Bug

@ofalvai Still you've not fixed the widget bug

Localization

How to contribute a Localized translation?

Widget not displaying correctly

When I place the widget on the home screen habits aren't displayed correctly.

Adding Notifications

Hi, thank you for this great app.
It would be great, if you can add notifications. I thought of an implementation, where you can select, if you will be notified every day or on which day of the week and on which time.
I would be pleased, if you would consider the proposed changes.

need to touch "complete" 2 or more times to finish a task

please add the action of needing to press "complete" more than once for each task done

like this app:

Distribute over F-Droid

I just found the app randomly on the Play Store about 20 minutes ago, it would be great if this app could be published to F-Droid and would allow new and privacy conscious users to use this app. The used BugSnachter dependency is a blocker, as it's proprietary, and non-foss dependencies cannot be included in an F-Droid app. Maybe it could be removed/made optional?

If the requirements of F-Droid cannot be met, an alternative would be to add it to the IzzyOnDroid repo.

Add Time feature (aesthetic/productive)

Add a thing so we can add time of the day for every habit so I don't have to write after every habit myself.

Plus
It would be cool if the app sends you reminder on that specific habit time.
And yeah I really like the minimalistic approach so try to keep it that way :)
Thanks
Sam

laging on newer phones

Hi thank you for creating this app I was relly impresst by the disegn and supporting for dynamic color from 1.0.2 but I found that the app is really laggy and not smother experience even on my snapdragon 6 gen phone like all the apps run smother and like butter, for example I was reply imprest for the compatibility between system and software and low battery use from the app Paisa Info's:
Phone: oppo a74 4g
Software: coloros 13
CPU: snapdragon 665
Irelly appresate you hardwork that you put on this app and iwant to help to translate the app to Arabic let me know how can I do that.

is the project dead?

[Feature Request] Reminder notifications and ability to set the frequency of habit e.g to do a habit for X days of the week or months etc.

Thank you so much for the amazing app <3

Widget Bug

There are too many bugs in widget

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Update plugin gradle-cachefix to v3

Detected dependencies

github-actions

.github/workflows/build-and-test.yml

actions/checkout v4

actions/cache v3

actions/setup-java v3

actions/upload-artifact v3

actions/upload-artifact v3

gradle

gradle.properties

settings.gradle

build.gradle

app/build.gradle

build-logic/settings.gradle.kts

build-logic/convention/build.gradle.kts

core-common/build.gradle

core-database/build.gradle

core-model/build.gradle

core-testing/build.gradle

core-ui/build.gradle

feature-dashboard/build.gradle

feature-insights/build.gradle

feature-misc/build.gradle

feature-widgets/build.gradle

gradle/libs.versions.toml

com.android.tools:desugar_jdk_libs 2.0.3

com.android.tools.build:gradle 8.1.2

org.jetbrains.kotlin:kotlin-gradle-plugin 1.9.10

org.jetbrains.kotlin:kotlin-reflect 1.9.10

org.jetbrains.kotlinx:kotlinx-coroutines-core 1.7.3

org.jetbrains.kotlinx:kotlinx-coroutines-test 1.7.3

org.jetbrains.kotlinx:kotlinx-collections-immutable 0.3.6

javax.inject:javax.inject 1

com.google.dagger:hilt-android 2.48.1

com.google.dagger:hilt-compiler 2.48.1

androidx.hilt:hilt-navigation-compose 1.0.0

com.google.dagger:hilt-android-testing 2.48.1

androidx.navigation:navigation-compose 2.7.4

androidx.activity:activity-compose 1.8.0

androidx.room:room-ktx 2.6.0

androidx.room:room-compiler 2.6.0

androidx.room:room-runtime 2.6.0

androidx.lifecycle:lifecycle-viewmodel-ktx 2.6.2

androidx.lifecycle:lifecycle-runtime-ktx 2.6.2

androidx.arch.core:core-testing 2.2.0

androidx.test:rules 1.5.0

androidx.test:runner 1.5.2

androidx.test.ext:junit 1.1.5

androidx.test.espresso:espresso-core 3.5.1

androidx.compose:compose-bom 2023.10.01

com.squareup.logcat:logcat 0.1

com.kizitonwose.calendar:compose 2.4.0

org.burnoutcrew.composereorderable:reorderable 0.8.1

com.google.accompanist:accompanist-systemuicontroller 0.32.0

com.google.accompanist:accompanist-navigation-animation 0.32.0

com.bugsnag:bugsnag-android-gradle-plugin 8.1.0

com.bugsnag:bugsnag-android-core 5.31.2

org.apache.commons:commons-csv 1.10.0

androidx.glance:glance-appwidget 1.0.0

com.airbnb.android:showkase-annotation 1.0.0-beta15

com.airbnb.android:showkase 1.0.0-beta15

com.airbnb.android:showkase-processor 1.0.0-beta15

junit:junit 4.13.2

org.mockito:mockito-android 5.6.0

org.mockito.kotlin:mockito-kotlin 5.1.0

app.cash.turbine:turbine 1.0.0

app.cash.licensee:licensee-gradle-plugin 1.8.0

com.spotify.ruler:ruler-gradle-plugin 1.4.0

com.google.devtools.ksp 1.9.10-1.0.13

com.osacky.doctor 0.8.1

com.asarkar.gradle.build-time-tracker 4.3.0

org.gradle.android.cache-fix 2.8.1

com.autonomousapps.dependency-analysis 1.25.0

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 8.4

Check this box to trigger a request for Renovate to run again on this repository

Option to distinguish between days that a habit was not done, vs no data/insufficient data. i.e., being able to differentiate between Yes, No and Maybe. Currently it's only marked for yes, and unmarked for No.
A percentage progress bar/variable that is calculated every day. Formula - (Habits marked done/Total no.of habits)*100 . Currently on the insights page, there is a gradient option to show how many habits were marked done, I don't find it intuitive and sometimes have trouble distinguishing colors
A graph on the insights page, with progress on the Y-axis and Days on the X-axis. Line graph, Area graph, or Column graphs are probably the best suited. It also kind of help visualize progress hence promoting more productivity.

Widgets

The widget the app gives glitches and doesn't show habits properly, I tried adding more and re-escaling but it's the same, also a different widget just to show habits tracking would be good :D

Image of the glitched widget: