Skip to content

BYLinMou/COMP3330-Gp20

Repository files navigation

📢 Important Notice

This repository is the official repo for the group project. This codebase is open-sourced up to version v0.0.11 with GPL-3.0 license. Subsequent development has been taken over by a team outside of the original group project, but APK updates will continue to be maintained on the release page. Code after v0.0.11 is not open source.

⚠️ Supabase Backend Compatibility Notice

APK releases v0.0.11 and earlier in this repository are no longer functional due to breaking changes in the remote Supabase backend structure. The backend has been restructured and is not backward-compatible with older versions.

  • To use this codebase: You must deploy your own Supabase instance (see supabase/README.md for setup instructions)
  • For ready-to-use APKs: Please visit the new project location below

🔗 New Project Location

AuraSpend - Smart Budgeting Companion

HKU COMP3330 (25-26 Sem 1) - Group 20

AuraSpend is a gamified, AI-powered expense tracking application built with React Native (Expo) and Supabase. It combines financial management with a digital pet companion to encourage healthy spending habits.

👥 Group Members

  • Xie Yee Lam
  • Chen Yifan
  • Zeng Ruo Xi

✨ Key Features

🎞️ Video Demo

1127.1.mp4

💰 Smart Finance Management

  • AI Receipt Scanning: Upload or take photos of receipts. The app uses multimodal LLMs (OpenAI/Gemini) to automatically extract merchant, items, amount, and categories.
  • Multi-Currency Support: Real-time currency conversion powered by Frankfurter API (Supports HKD, USD, CNY, JPY, etc.).
  • Budget Tracking: Set monthly or yearly budgets with visual progress bars and alerts.
  • Detailed Reports: Interactive charts showing spending trends, category breakdowns, and merchant summaries.

🤖 AI Agent (Aura Assistant)

  • Floating Chat: An integrated AI assistant that can answer questions about your spending, summarize data, and perform actions via natural language (e.g., "How much did I spend on food last week?").

🐾 Gamification (Pet System)

  • Digital Companion: Your financial habits affect your pet's mood and hunger.
  • Level Up: Gain XP by logging transactions and staying within budget.
  • Rewards: Unlock outfits and new pets as you progress.

🛠 Technical Highlights

  • Real-time Sync: Data synchronizes instantly across devices using Supabase Realtime.
  • Offline Support: Built-in caching for currencies and essential data.
  • Customizable: Support for dark mode, custom categories, and multiple languages (English/Chinese).

🏗 Tech Stack

  • Frontend: React Native, Expo, Expo Router, Reanimated
  • Backend: Supabase (PostgreSQL, Auth, Realtime, Storage)
  • AI Integration: OpenAI-compatible APIs
  • Language: TypeScript

🚀 Getting Started

Receipt Extraction Model Testing (Optional)

You can use the Python tool in TestTools/ReceiptSmartAnalyzer to test and evaluate receipt information extraction capabilities. See its README for usage instructions.

Supabase Setup (Optional)

If you want to set up your own Supabase backend, see supabase/README.md for step-by-step instructions and example SQL to initialize your database.

Prerequisites

1. Clone and Install

# Clone the repository
git clone https://github.com/BYLinMou/COMP3330-Gp20-AuraSpend.git

# Navigate to project folder
cd COMP3330-Gp20-AuraSpend

cp .env.example .env

# Install dependencies
npm install

# Start Project
npm run start

About

AuraSpend (Prototype of HKU COMP3330 25-26 sem1 Gp20)

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors