Skip to content

Your smart companion for effortless expense tracking and financial clarity.

License

Notifications You must be signed in to change notification settings

itz-Hiru/budget-buddy

Repository files navigation

Budget Buddy 💸 Financial Freedom in Your Pocket! 📱

🌟 Quick Overview

Budget Buddy is your personal financial companion, transforming complex money management into a breeze. Track expenses, visualize spending, and take control of your financial journey with just a few taps!

✨ Key Features

  • Smart Expense Tracking 📊 Effortlessly log income and expenses with intuitive categorization
  • Insightful Visualizations 📈 Beautiful charts that turn numbers into meaningful insights
  • Flexible Reporting 📄 Generate comprehensive PDF reports at your fingertips
  • Mood-Adaptive Design 🌓 Seamless light and dark mode to match your style and comfort

🏗️ App Structure

budget-buddy/
│
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/hirumitha/budget/buddy/
│   │   │   │   ├── adapters/
│   │   │   │   │   ├── MainActivity.kt
│   │   │   │   │   └── SplashActivity.kt
│   │   │   │   │
│   │   │   │   ├── adapters/
│   │   │   │   │   ├── PrecentValueFormatter.kt
│   │   │   │   │   └── TransactionAdapter.kt
│   │   │   │   │
│   │   │   │   ├── database/
│   │   │   │   │   └── TransactionDBHelper.kt
│   │   │   │   │
│   │   │   │   ├── fragments/
│   │   │   │   │   ├── home/
│   │   │   │   │   ├── summary/
│   │   │   │   │   └── transaction/
│   │   │   │   │
│   │   │   │   ├── models/
│   │   │   │   │   └── TransactionModel.kt
│   │   │   │   │
│   │   │   │   └── utils/
│   │   │   │       └── PDFUtils.kt
│   │   │   │
│   │   │   └── res/
│   │   │       ├── layout/
│   │   │       ├── drawable/
│   │   │       ├── values/
│   │   │       └── navigation/
│   │   │
│   │   └── test/
│   │       └── java/
│   │           └── unit tests/
│   │
│   └── build.gradle.kts
│
└── gradle/
    └── wrapper/
        └── gradle-wrapper.properties

🔧 Tech Magic Behind Budget Buddy

  • Language: Kotlin 🏎️ (Because fast and safe coding matters!)
  • Architecture: MVVM (Model-View-ViewModel)
  • Key Libraries:
    • 📊 MPAndroidChart for stunning visualizations
    • 🧭 Android Navigation Component for smooth transitions
    • 📄 PDF Generation Library for professional reports

🚀 Getting Started

Prerequisites

  • 📱 Android 7.0 (Nougat) or higher
  • 💻 Android Studio Lady Bug or later

Installation Steps

  1. 🍴 Clone the repository

    git clone https://github.com/itz-Hiru/budget-buddy.git
  2. 🔨 Open in Android Studio

    • File > Open > Select budget-buddy folder
  3. 🔄 Sync Gradle files

    • Let Android Studio download and sync dependencies
  4. 🏃‍♀️ Run the app

    • Select an emulator or connect a physical device

🌈 User Experience Highlights

  • Intuitive Interface: Designed for financial novices and experts alike
  • Dark/Light Modes: Your eyes, your choice
  • Secure: Your financial data stays private
  • Offline Support: Track expenses anywhere, anytime

🤝 Contribution Guidelines

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch
    git checkout -b feature/financial-awesomeness
  3. 💾 Commit changes
  4. 📤 Push to your branch
  5. 🔀 Open a Pull Request

📄 License

MIT License - Spread financial freedom!

🌍 Connect & Grow

🙌 Shoutout to Open Source

Huge thanks to the amazing libraries and tools that make Budget Buddy possible!


💡 Pro Tip: Every expense tracked is a step towards financial wisdom! 🧠💰


I've enhanced the README with:
- A more vibrant and engaging tone
- Detailed app structure breakdown
- Emoji-rich sections for visual appeal
- More context about the app's philosophy
- A pro tip to make it more motivational

The app structure provides a clear view of the project organization, showcasing a professional MVVM architecture with clear separation of concerns.

Would you like me to adjust anything to make it even more appealing or specific to your implementation?

Releases

No releases published

Packages

No packages published

Languages