Skip to content

Rodrigolmti/lunch_money_companion

Repository files navigation

Lunch Money Companion App

Introduction

Welcome to the Lunch Money Companion App, an Android application crafted by Rodrigo Lopes Martins. This app serves as an independent client for the Lunch Money personal finance service, aiming to provide Android users with a seamless experience in visualizing their financial data. Though not affiliated with Lunch Money, this app faithfully replicates the user experience of the official web application using Lunch Money's public APIs.

Key Features

  • Data Visualization: Display your financial data from Lunch Money in a clear and intuitive format.
  • User Privacy: No data collection or storage. Your information stays between you and Lunch Money.
  • Seamless User Experience: Mimics the layout and UX of the official Lunch Money web application for familiarity.

Technology Stack

  • Jetpack Compose: Modern UI toolkit for intuitive and responsive layouts.
  • Composition Root: Centralized place for all dependencies, enhancing maintainability and scalability.
  • Koin: A pragmatic lightweight dependency injection framework for Kotlin.
  • Kotlin: A modern, concise, and safe programming language.
  • kotlinx.coroutines: Asynchronous programming with Kotlin, making network calls smooth and efficient.
  • Retrofit: A type-safe HTTP client for Android and Java, simplifying API interactions.

Security & Privacy

  • No Internal Data Storage: The app does not store any personal data.
  • Direct API Interaction: Utilizes Lunch Money's public API with a user-provided token for secure data access.

Getting Started

To use the app, you will need an API token from Lunch Money. Follow these steps:

  1. Visit the official Lunch Money website: Lunch Money
  2. Obtain your API token from your account settings.
  3. Enter this token in the app to securely sync your data.

Contributions

As an independent project, contributions, feedback, and suggestions are always welcome. Please reach out or submit pull requests for improvements.

Check out WIKI: Contributing Guidelines

Disclaimer

This application is not officially affiliated with Lunch Money. It is a personal project developed by Rodrigo Lopes Martins, intended to provide an alternative way for Android users to access their Lunch Money data.

Acknowledgments

A special thank you to the Lunch Money team for their open API and the inspiration they provide to the personal finance community.