/FlatFair

FlatFair is an expense management and group tracking app. Built for CS4278.

Primary LanguageTypeScript

FlatFair

FlatFair is an expense management and group tracking application designed for efficiently managing shared expenses among roommates, friends, or groups. It simplifies the process of tracking who owes what, categorizing expenses, and settling balances, all within an intuitive user interface.

Project Overview

FlatFair allows users to:

  • Create groups to manage shared expenses.
  • Log, categorize, and upload receipts for group expenses.
  • Automatically track spending history and generate reports.
  • Integrate payment platforms like Venmo or PayPal for seamless settlements.
  • Receive notifications and reminders for outstanding balances.

Tech Stack

  • Frontend: React with TypeScript
  • Backend: Node.js with Express.js
  • Database: MongoDB
  • UI Libraries: Chakra UI & Tailwind CSS
  • Authentication: Auth0
  • API Integration: OpenAI API (for intelligent features)
  • Email Service: SendGrid (for email notifications)
  • SMS Service: Twilio (for SMS notifications)

Tools & Project Management

  • Version Control: GitHub (for collaboration and CI/CD)
  • Communication: Discord (for team discussions)
  • Task Management: Trello (for sprint planning and task tracking)

Setup Instructions

  1. Clone the repository.
  2. Install dependencies using npm install.
  3. Set up your environment variables for MongoDB, Auth0, and API keys.
  4. Run the application using npm start.

FlatFair aims to provide a seamless, user-friendly experience for managing group expenses, with integrations that streamline financial settlements and provide helpful insights.