Skip to content

Arungharami/Smart-Finance-AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Paste this into Smart-Finance-AI/README.md:

# Smart-Finance-AI

A modern Android personal finance tracker built with **Kotlin**, **Jetpack Compose**, **Material 3**, **Room Database**, and **MVVM architecture**. Smart-Finance-AI helps users record income and expenses, view financial summaries, analyze spending patterns, and manage transactions in a clean mobile-first interface.

---

## Overview

**Smart-Finance-AI** is designed as a production-ready Android finance management app. The app focuses on simple transaction tracking, clear financial insights, and a polished modern UI suitable for portfolio, academic, and real-world Android development demonstration.

The project follows clean Android architecture principles, using separate layers for UI, ViewModel, repository, and local database logic.

---

## Key Features

- Add income and expense transactions
- Edit and delete existing transactions
- View total balance, income, and expense summary
- Categorize transactions
- Track transaction date and type
- Local offline storage using Room Database
- Reactive UI updates using StateFlow
- Modern Jetpack Compose interface
- Material 3 design system
- Clean MVVM architecture
- Fast local querying with Room indices
- Production-style folder structure

---

## Tech Stack

| Area | Technology |
|---|---|
| Language | Kotlin |
| UI | Jetpack Compose |
| Design | Material 3 |
| Architecture | MVVM |
| Database | Room |
| State Management | StateFlow |
| Async | Kotlin Coroutines |
| Build System | Gradle |
| IDE | Android Studio |

---

## App Architecture

The project uses a clean MVVM-based structure:

```text
Smart-Finance-AI/

├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/example/smartfinanceai/
│   │   │   │       ├── data/
│   │   │   │       │   ├── Transaction.kt
│   │   │   │       │   ├── TransactionDao.kt
│   │   │   │       │   └── AppDatabase.kt
│   │   │   │       │
│   │   │   │       ├── repository/
│   │   │   │       │   └── TransactionRepository.kt
│   │   │   │       │
│   │   │   │       ├── ui/
│   │   │   │       │   ├── screens/
│   │   │   │       │   ├── components/
│   │   │   │       │   └── theme/
│   │   │   │       │
│   │   │   │       ├── viewmodel/
│   │   │   │       │   └── TransactionViewModel.kt
│   │   │   │       │
│   │   │   │       └── MainActivity.kt
│   │   │   │
│   │   │   └── AndroidManifest.xml
│   │
│   └── build.gradle.kts

├── build.gradle.kts
├── settings.gradle.kts
└── README.md

Main Screens

Dashboard Screen

The dashboard displays the user’s main financial summary:

  • Current balance
  • Total income
  • Total expenses
  • Recent transactions
  • Clean metric cards
  • Modern glass-style UI components

Add Transaction Screen

The add transaction screen allows users to enter:

  • Transaction title
  • Amount
  • Category
  • Transaction type
  • Date
  • Notes or description

It supports validation, editing, and smooth navigation.

Transaction List

The transaction list gives users a clear view of their financial activity with transaction details, categories, and amounts.


Database Design

The app uses Room Database for local offline data persistence.

Example transaction model:

@Entity(
    tableName = "transactions",
    indices = [
        Index(value = ["timestamp"]),
        Index(value = ["type"])
    ]
)
data class Transaction(
    @PrimaryKey(autoGenerate = true)
    val id: Int = 0,
    val title: String,
    val amount: Double,
    val category: String,
    val type: String,
    val timestamp: Long,
    val note: String? = null
)

Why This Project Is Important

Smart-Finance-AI demonstrates practical Android development skills including:

  • Modern Android app development
  • Jetpack Compose UI design
  • Room database integration
  • MVVM architecture
  • Reactive state handling
  • Clean project organization
  • Production-ready coding practices

This project is suitable for:

  • Android portfolio
  • GitHub showcase
  • Academic submission
  • Resume project
  • App development practice
  • Future AI-powered finance assistant integration

Future Improvements

Planned future features:

  • AI-powered spending insights
  • Monthly financial reports
  • Budget planning
  • Expense category charts
  • Export transactions to CSV or PDF
  • Cloud sync with Firebase
  • Login and account system
  • Push notification reminders
  • Recurring transaction support
  • Voice-based transaction entry
  • Dark mode improvements
  • Multi-currency support

Getting Started

Requirements

Before running this project, install:

  • Android Studio
  • JDK 17 or higher
  • Android SDK
  • Gradle
  • Kotlin support
  • Android Emulator or physical Android device

Installation

1. Clone the Repository

git clone https://github.com/Arungharami/Smart-Finance-AI.git

2. Open in Android Studio

Open Android Studio and select:

File > Open > Smart-Finance-AI

3. Sync Gradle

Allow Android Studio to sync all Gradle dependencies.

4. Build the Project

For Windows PowerShell:

$env:JAVA_HOME='C:\Program Files\Android\Android Studio\jbr'
.\gradlew.bat assembleDebug

For macOS/Linux:

./gradlew assembleDebug

5. Run the App

Select an emulator or connected Android device, then click Run in Android Studio.


Build Status

Current build command:

./gradlew assembleDebug

Expected result:

BUILD SUCCESSFUL

Screenshots

Add screenshots here after running the app.

screenshots/
├── dashboard.png
├── add-transaction.png
├── transaction-list.png
└── edit-transaction.png

Example README screenshot section:

## Screenshots

| Dashboard | Add Transaction | Transaction List |
|---|---|---|
| ![Dashboard](screenshots/dashboard.png) | ![Add Transaction](screenshots/add-transaction.png) | ![Transaction List](screenshots/transaction-list.png) |

Project Highlights

  • Clean Android architecture
  • Modern Compose UI
  • Local offline-first database
  • Scalable code structure
  • Easy to extend with AI features
  • Good foundation for a real finance app

Possible AI Features

This project can be expanded into a full AI finance assistant by adding:

  • Spending prediction
  • Smart category detection
  • Monthly budget recommendations
  • Financial risk alerts
  • Natural language finance search
  • AI chatbot for personal finance questions
  • Automatic transaction classification

Example:

User: How much did I spend on food this month?
AI: You spent $325 on food this month, which is 18% higher than last month.

Repository Name

Recommended repository name:

Smart-Finance-AI

Alternative names:

SmartFinanceAI
AI-Finance-Tracker
Compose-Finance-Tracker
Personal-Finance-AI

Author

Arun Kumar Gharami AI Engineer & Applied Researcher Android, AI, Machine Learning, and Automation Developer

GitHub: Arungharami


Disclaimer

Smart-Finance-AI is a personal finance tracking application created for educational, portfolio, and development purposes. It does not provide professional financial, tax, investment, or legal advice.


License

This project is open source and available under the MIT License.

MIT License

Copyright (c) 2026 Arun Kumar Gharami

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files, to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software,
subject to the conditions of the MIT License.

Final Project Summary

Smart-Finance-AI is a modern Android finance tracking app built with Kotlin, Jetpack Compose, Material 3, Room, and MVVM architecture. It provides a strong foundation for personal finance management and future AI-powered financial insights.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages