Skip to content

stovie93/AndroidFinanceApp

Repository files navigation

AndroidFinanceApp

A personal finance tracking Android application built with Kotlin and Jetpack Compose. Track your expenses, manage categories, and monitor your spending habits.

Features

  • Add and track expenses
  • Categorize expenses with predefined categories
  • View spending summary and balance
  • Local data persistence with Room database
  • Modern Material Design 3 UI

Prerequisites

Before you begin, ensure you have the following installed:

  • Android Studio: Hedgehog (2023.1.1) or newer
  • JDK: Java Development Kit 8 or higher
  • Android SDK: API Level 34 (Android 14)
  • Minimum Android version: API Level 24 (Android 7.0)

Getting Started

1. Clone the Repository

git clone <repository-url>
cd AndroidFinanceApp

2. Open in Android Studio

  1. Launch Android Studio
  2. Click "Open" or "File > Open"
  3. Navigate to the AndroidFinanceApp directory
  4. Click "OK" to open the project

3. Sync Project

Android Studio will automatically detect the Gradle files and prompt you to sync. If not:

  1. Click "File > Sync Project with Gradle Files"
  2. Wait for the sync to complete

4. Set Up an Emulator or Device

Option A: Using an Emulator

  1. Open "Device Manager" in Android Studio
  2. Click "Create Device"
  3. Select a device (e.g., Pixel 5)
  4. Download and select a system image (API 24 or higher recommended)
  5. Finish the setup

Option B: Using a Physical Device

  1. Enable Developer Options on your Android device
  2. Enable USB Debugging
  3. Connect your device via USB
  4. Accept the USB debugging prompt on your device

5. Build and Run

  1. Select your target device/emulator from the device dropdown
  2. Click the "Run" button (green play icon) or press Shift+F10
  3. Wait for the build to complete
  4. The app will launch automatically on your device/emulator

Project Structure

app/src/main/java/com/financeapp/
├── data/
│   ├── local/          # Room database setup
│   ├── model/          # Data models
│   └── repository/     # Data repositories
├── ui/
│   ├── components/     # Reusable UI components
│   ├── screens/        # App screens
│   └── theme/          # Material theme configuration
├── navigation/         # Navigation setup
└── MainActivity.kt     # Main entry point

Technologies Used

  • Language: Kotlin 1.9.20
  • UI Framework: Jetpack Compose with Material 3
  • Architecture: MVVM (Model-View-ViewModel)
  • Database: Room 2.6.1
  • Async: Kotlin Coroutines
  • Navigation: Jetpack Navigation Compose
  • Build System: Gradle (Kotlin DSL)

Build Variants

  • Debug: Development build with debugging enabled
  • Release: Optimized production build

To create a release build:

./gradlew assembleRelease

Troubleshooting

Gradle sync fails:

  • Ensure you have a stable internet connection
  • Try "File > Invalidate Caches / Restart"
  • Check that you have the correct JDK version

App won't run on device:

  • Verify USB debugging is enabled
  • Check that minimum SDK requirements are met (API 24+)
  • Try running ./gradlew clean and rebuilding

Build errors:

  • Make sure Android SDK API Level 34 is installed
  • Verify Kotlin plugin is up to date in Android Studio

About

Personal finance tracker for Android. Kotlin + Jetpack Compose with Room-backed local persistence, Material 3 UI, and categorized expense tracking.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages