EaseExpense

An AI expenseTracker app to track your expense without your manual managing.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact
6. Acknowledgments

About The Project

EaseExpense is an AI-powered expense tracker app designed to simplify your financial management by automatically capturing your expenses from incoming SMS messages.

How it works:

• The app listens for incoming SMS on your phone, such as bank transaction alerts or payment notifications.
• Each SMS is sent securely to the backend server.
• The backend uses the Mistral API key with a Large Language Model (LLM) to extract important details like the transaction amount, currency, and merchant name.
• Extracted expenses are then displayed to you in an organized, user-friendly interface — no manual entry required!

With EaseExpense, managing your expenses becomes effortless and accurate, helping you stay on top of your budget without the hassle of manual tracking.

Project structure

(back to top)

Built With

Technology	Badge
Java
Spring Boot
Gradle
Apache Kafka
Docker
MySQL
Kong
React Native

(back to top)

Getting Started

Follow below instructions to setup the environment if you want to test in the frontend follow this Link

Prerequisites

Make sure you have the following tools and credentials:

• Docker
• Docker Compose
• (Optional) Git
• Mistral API Key — Obtain your API key from Mistral and have it ready for configuring your environment

Installation

1. Get a free API Key at https://mistral.ai/)

2. Clone the repo

   git clone https://github.com/github_username/repo_name.git

3. Navigate to expenseTrackerApp and make a .env file there

   MYSQL_USER=YOUR-USERNAME
   MYSQL_PASSWORD=YOUR_PASSWORD
   MYSQL_ROOT_USER=root
   MYSQL_ROOT_PASSWORD=password
   
   SPRING_AI_MISTRALAI_API_KEY= YOUR_API_KEY

(back to top)

Usage

Navigate to expenseTrackerApp and up your containers to test it

docker compose up -d

To test in the frontend, refer to this Link

(back to top)

Roadmap

• Listen for incoming SMS and generate expense in the app automatically
• Add Logout feature
• Add Additional UI
• Add category level expenses
• Deploy the project in AWS

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

(back to top)

Acknowledgments

• Mistral AI
• Img Shields
• Gluestack-UI

(back to top)