README.md

Budget+ Android App（極簡記帳）

Budget+ is an easy to use co-spending tracker to track expenses together with your friends and family.

Feature Overview

And some cool animated features! ✨

Pie Chart	Color Tone Picker	Customize Color Tone
screen-20240707-170558.2.mp4	screen-20240707-170638.3.mp4	screen-20240707-170638.4.mp4

Download

https://play.google.com/store/apps/details?id=com.kevlina.budgetplus

Tech stack

• Jetpack Compose for UI + MVVM Architecture
• Coroutines & Flow for asynchronous work
• Hilt for dependency injection
• Lottie Compose for animation
• Navigation Compose for deeplink and navigation
• Google Billing for in-app purchases
• Admob with meta audience network mediation for Ads
• Coil for image loading
• Kotlinx serialization for parsing JSON
• Firebase Firestore for database
• Firebase Authentication, Analytics, Messaging and Remote Config
• In-app Review and In-app Update integration
• Baseline Profile for speeding up app startup time
• Mockk and Truth for unit testing

Other used open source libraries

• orchestra-colorpicker for color picker view
• reorderable for reorder items in compose
• kotlin-csv-jvm for exporting data as csv file
• detekt for Kotlin static code analysis
• exp4j for math expression evaluation

Supported Deeplinks

• Home screen: https://budgetplus.cchi.tw/record
• Overview: https://budgetplus.cchi.tw/overview
• Unlock premium: https://budgetplus.cchi.tw/unlockPremium
• Settings: https://budgetplus.cchi.tw/settings
• Settings with members dialog: https://budgetplus.cchi.tw/settings?showMembers=true
• Sharing customized color tones: https://budgetplus.cchi.tw/colors?hex=cff1ff%3bdaf2cb%3b84c18f%3b596980

Baseline Profile

The project uses baseline profile to speed up the app start up time.

How to run?

./gradlew :benchmark:connectedReleaseAndroidTest -P android.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=BaselineProfile

Locate it in the build folder of the module you generated the profile in: [module]/build/outputs/connected_android_test_additional_output/release/connected/[device].

Copy and rename the file to baseline-prof.txt and place it in the src/main directory of your app module

For Macrobenchmark:

./gradlew :benchmark:connectedReleaseAndroidTest -P android.testInstrumentationRunnerArguments.androidx.benchmark.enabledRules=Macrobenchmark

Firebase Cloud Functions

Database interactions and push notifications are all implemented with Firebase Cloud Functions, the repo is opened source as well: https://github.com/kevinguitar/budgetplus-cloud-functions

License

Copyright (c) 2024 kevinguitar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.