Skip to content

FlutterFoundry/simpelbudget

Repository files navigation

Simpelbudget

App Icon

Flutter Version License: MIT Platforms Localization

Simpelbudget is a budget tracking Flutter application that helps you manage your expenses and incomes efficiently. It supports manual entry as well as receipt scanning with OCR and AI-powered detail extraction.

Features

  • Add, edit, and delete transactions (expenses and incomes)
  • Scan receipt images using Google ML Kit text recognition
  • Extract structured receipt details (items, subtotal, total, tax) via OpenAI Chat API
  • View summary dashboard for your current billing period
  • View detailed transaction list with filtering options
  • Configure billing cycle cutoff day and currency in settings
  • Persistent local storage using SQLite
  • Internationalization support (English and Indonesian)
  • Cross-platform support: Android, iOS, Web, macOS, Windows, Linux

Prerequisites

  • Flutter SDK (>= 3.7.2)
  • Dart SDK
  • OpenAI API key

Setup

  1. Clone the repository:

    git clone <repository-url>
    cd simpelbudget
  2. Install dependencies:

    flutter pub get
  3. Create a .env file in the project root with your OpenAI API key:

    OPENAI_API_KEY=your_openai_api_key_here
    
  4. Ensure the .env file is included in the Flutter assets (configured in pubspec.yaml).

Running the App

  • To run on a connected device or simulator:

    flutter run
  • To specify a platform:

    flutter run -d android
    flutter run -d ios
    flutter run -d chrome

Building

  • Build Android APK:

    flutter build apk --release
  • Build iOS (requires a Mac):

    flutter build ios --release
  • Build Web:

    flutter build web --release
  • Build macOS:

    flutter build macos --release
  • Build Windows:

    flutter build windows --release
  • Build Linux:

    flutter build linux --release

Testing

Run unit and widget tests:

flutter test

Project Structure

.
├── android/            # Android platform code
├── ios/                # iOS platform code
├── web/                # Web build target
├── macos/              # macOS platform code
├── windows/            # Windows platform code
├── linux/              # Linux platform code
├── lib/                # Dart source code
│   ├── l10n/           # Localization resource files (ARB)
│   ├── main.dart       # App entry point and routing
│   ├── models/         # Data model classes
│   ├── pages/          # UI screen implementations
│   ├── services/       # Data access and business logic
│   └── widgets/        # Reusable widgets
├── test/               # Automated tests
├── .env                # Environment variables (OpenAI API key)
└── pubspec.yaml        # Project configuration and dependencies

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests for bug fixes and enhancements.

Acknowledgements

Happy budgeting!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published