Skip to content

Latest commit

 

History

History
156 lines (114 loc) · 4.02 KB

README.md

File metadata and controls

156 lines (114 loc) · 4.02 KB

💰 Smart Expense Tracker

🌟 Project Overview

A robust JavaFX application designed to provide comprehensive personal finance management with advanced tracking, visualization, and logging capabilities.

🛠 Tech Stack

Java JavaFX IntelliJ IDEA

📚 Key Technologies

  • 📊 JavaFX: Modern UI Framework
  • 📝 Logging: Comprehensive Activity Tracking
  • 📈 Charts: Pie Chart Visualization
  • 💾 Data Persistence: Save and Load Functionality

✨ Key Features

  • 💸 Expense and Income Tracking
  • 📊 Interactive Pie Chart Visualization
  • 📝 Detailed Activity Logging
  • 💰 Budget Management
    • Yearly Budget Tracking
    • Monthly Budget Setting
  • 🗂️ Transaction Management
    • Add Transactions
    • View Transactions in Table Format
  • 💾 Data Persistence
    • Save Financial Data
    • Load Saved Financial Information

🚀 Getting Started

Prerequisites

  • Java Development Kit (JDK) 11+
  • IntelliJ IDEA
  • Maven or Gradle (depending on your project setup)

Installation

  1. Clone the repository

    git clone https://github.com/itz-Hiru/Smart-Expense-Tracker.git

  2. Open the project in IntelliJ IDEA

    • File > Open > Select project directory

  3. Resolve Dependencies

    • Ensure all required libraries are downloaded
    • Check Maven/Gradle configurations

🔧 Project Structure

smart-expense-tracker/
│
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/hiru/smartexpensetracker/
│   │   │       ├── controllers/
│   │   │       ├── models/
│   │   │       ├── utils/
│   │   │       └── views/
│   │   │       └── FinanceTrackerGUI.java
│   │   │       └── module-info.java
│   │   └── resources/
│   │       ├── css/
│   │       └── fxml/
│
├── .gitignore
├── LICENSE
├── mvnw
├── mvnw.cmd
├── pom.xml
└── README.md

🖥️ Application Functionality

Core Modules

  1. Transaction Management

    • Add new income and expense transactions
    • Categorize transactions
    • View transactions in detailed table view

  2. Budget Tracking

    • Set yearly and monthly budgets
    • Real-time budget progress tracking

  3. Visualization

    • Interactive pie charts
    • Expense distribution analysis

  4. Logging System

    • Comprehensive activity logging
    • Track all actions performed in the application

🛠️ Build and Run

Using IntelliJ IDEA

  1. Open the project
  2. Resolve dependencies
  3. Run the main application class

Command Line

# If using Maven
mvn clean javafx:run

# If using Gradle
gradle clean run

🤝 How to Contribute

  1. Fork the Project
  2. Create Feature Branch (git checkout -b feature/FinanceFeature)
  3. Commit Changes (git commit -m 'Add new financial reporting feature')
  4. Push to Branch (git push origin feature/FinanceFeature)
  5. Open Pull Request

🔒 Data Privacy

  • Local data storage
  • No cloud dependencies
  • Secure transaction tracking

📊 Performance Considerations

  • Efficient data handling
  • Optimized JavaFX rendering
  • Minimal resource consumption

📧 Connect & Support

GitHub LinkedIn

📄 License

Distributed under the MIT License. See LICENSE for more information.

🌈 Empowering Personal Finance Management with Technology 💸

Visitor Count