Skip to content

Christian-2003/cha-ching

Repository files navigation

Cha Ching

GitHub GitHub GitHub

Do you want to know how much money you have earned? Cha Ching makes you store all your incomes and regular expenses, such as salaries, bonuses, taxes or insurance payments - all on your Android device locally.

Table of Contents
  1. Description
  2. Install and Use the Project
  3. Contributors
  4. License
  5. How to Contribute
  6. Additional Images

Description

Cha Ching allows you to store your incomes and regular expenses on your device locally. You can configure the type of transactions, such as salaries, bonuses, taxes or insurance payments.

Technologies Used

The application is developed with Jetpack Compose using Android Studio IDE. Therefore, the app is built using Gradle.

The app uses Material Design 3 Expressive to implement a comfortable user interface that is visually pleasing. Users should be able to work with the user interface of the app intuitively.

Miscellaneous

The version numbers for this project are determined based on the guidelines provided by semver.

The project contains a changelog which documents all changes that were made to the application in between software versions.


Install and Use the Project

This section helps you to install and use the app on you Android device.

System Requirements

In order to use Cha Ching, you need to fulfil the following requirements:

  • Have an Android device with version Android 14 or higher. The preferred version is Android 15.
  • Have 8 MB of internal storage
Installation Guide

In order to install the app on your Android device, consider the following steps:

  1. Download the latest version of the APK file through GitHub releases.
  2. Locate the APK file downloaded through your file explorer. The APK file is typically stored in the "Downloads"-folder.
  3. Click on the downloaded APK file.
  4. Usually, a dialog appears that makes you confirm the installaton. On this dialog, click "Confirm".
  5. Usually, Google Play Protect wants to scan the app before installing. Click "Scan" on the next dialog.
  6. Once Google Play Protect finishes scanning the app, click "Continue".
  7. Now, the app has been installed successfully.
First Steps

The app includes an onboarding feature. Go through the onboarding process and select the types of transactions you want to track at the end. On the main screen, you can add transactions for the selected types through the "+" button at the bottom right hand corner.
You can add custom types of transactions as well through the "Categories"-button.


Contributors

Currently, I (Christian-2003) am the only developer.


License

The project is licensed under the terms and conditions of the MIT license. You can view a copy of the license here.


How to Contribute

If you want to contribute to this project, feel free to do so.

Feel free to open issues, for anything you feel is appropriate. If you want to report bugs, please provide steps to reproduce the bug.

If you want to contribute to the code development, be a self respecting person and use the coding guidelines for Java that are taught in school and university.

A few guides for development-purposes are published here. If you are interested in contributing, this would be a good start.

The project will be developed in English.


Additional Images



2025-01-10
© Christian-2003

About

Do you want to know how much money you have earned? Cha Ching makes you store all your incomes, such as salaries or bonuses, on your Android device locally.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages