Skip to content

README.md

Latest commit

 

History

History
104 lines (75 loc) · 3.19 KB

README.md

File metadata and controls

104 lines (75 loc) · 3.19 KB

SplitBuddy – Effortless Group Expense Management

SplitBuddy is a modern web application designed to make splitting expenses with friends, roommates, or groups simple, transparent, and stress-free. Whether you’re sharing rent, planning a trip, or managing group activities, SplitBuddy helps you keep track of who paid, who owes, and settle up with ease.

✨ Features

  • Create and Manage Groups

    • Start groups for roommates, trips, events, or any shared activity.
    • Invite friends by email—even if they’re not on the platform yet.
    • See all your groups and contacts in one place.

  • Add and Track Expenses

    • Record expenses for individuals or groups.
    • Assign who paid and split the bill among participants.
    • Attach categories to expenses for better organization.

  • Flexible Splitting Options

    • Split expenses equally, by percentage, or by exact amounts.
    • Perfect for any scenario—dinners, trips, shared bills, and more.

  • Smart Settlements

    • Instantly see who owes what and to whom.
    • Our algorithm minimizes the number of payments needed to settle up.

  • Expense Analytics

    • Visualize your spending patterns and group balances.
    • Get insights into your shared costs and financial habits.

  • Real-Time Updates

    • See new expenses, repayments, and settlements the moment they’re added.
    • No need to refresh—everything updates live.

  • Automated Payment Reminders

    • Receive reminders for pending debts.
    • Never forget to settle up with friends.

  • Invite and Notify

    • Add new contacts by email and automatically send them an invitation to join.
    • New users receive a friendly email with a signup link.

  • Secure Authentication

    • Sign in and manage your account securely with modern authentication.

  • Mobile-Friendly and Responsive

    • Enjoy a seamless experience on desktop, tablet, or mobile.

🚀 How It Works

  1. Create or Join a Group

    • Start a group for your shared activity and invite friends.

  2. Add Expenses

    • Record who paid and how the bill should be split.

  3. Settle Up

    • View balances, see who owes what, and log payments when debts are cleared.

🛠️ Tech Stack

  • Next.js (App Router)
  • Convex (Realtime backend/database)
  • Clerk (Authentication)
  • Tailwind CSS (Styling)
  • Framer Motion (Animations)
  • React Spinners (Loaders)
  • Resend (Transactional email for invitations)

💡 Perfect For

  • Roommates splitting rent and utilities
  • Friends planning trips or events
  • Couples managing shared expenses
  • Anyone who wants to keep group finances transparent and fair

📬 Get Started

  1. Clone the repository and install dependencies: 
    git clone <your-repo-url>
cd equaltab
npm install
# or yarn install
  2. Run the development server: 
    npm run dev
# or yarn dev
  3. Open http://localhost:3000 in your browser.
  4. Sign up and create your first group. Add your friends or roommates. Start adding expenses and let SplitBuddy do the math!

If you need more technical setup instructions (environment variables, deployment, etc.), see the codebase or contact the maintainer.