SwiftSplit 💰

A modern, real-time expense splitting app built with Next.js and Firebase.

Split bills with friends effortlessly! Track expenses, manage groups, and settle up with ease.

---

✨ Features

• 🚀 Real-time Updates - See changes instantly across all devices
• 👥 Group Management - Create and manage expense groups
• 💸 Bill Splitting - Split expenses equally or by custom amounts
• 📊 Analytics - Visualize spending patterns with charts
• 🔐 Secure Authentication - Firebase Auth with email/password
• 🎨 Beautiful UI - Modern design with Tailwind CSS and Radix UI
• 📱 Responsive - Works perfectly on mobile and desktop
• 🌙 Dark Mode - Easy on the eyes (coming soon)
• 💾 Offline Support - Continue tracking expenses without internet

---

🚀 Quick Start

Prerequisites

• Node.js 18+ and npm
• Firebase account (Create one here)

Installation

1. Clone the repository

   git clone https://github.com/pavan6cs/SwiftSplit.git
   cd SwiftSplit

2. Install dependencies

   npm install

3. Set up Firebase

   • Create a new Firebase project at Firebase Console
   • Enable Authentication (Email/Password)
   • Enable Firestore Database
   • Copy your Firebase config

4. Configure environment variables

   cp .env.example .env.local

   Edit .env.local with your Firebase credentials:

   NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
   NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
   NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
   NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
   NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
   NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id

5. Set up Firestore Security Rules

   In Firebase Console → Firestore Database → Rules, add:

   rules_version = '2';
   service cloud.firestore {
     match /databases/{database}/documents {
       match /users/{userId} {
         allow read: if request.auth != null;
         allow write: if request.auth.uid == userId;
       }
       match /groups/{groupId} {
         allow read, write: if request.auth != null && 
           request.auth.uid in resource.data.members;
       }
       match /bills/{billId} {
         allow read, write: if request.auth != null;
       }
       match /activities/{activityId} {
         allow read: if request.auth != null && 
           request.auth.uid in resource.data.involved;
       }
     }
   }
   

6. Run the development server

   npm run dev

7. Open your browser

   http://localhost:9002
   

---

📁 Project Structure

SwiftSplit/
├── src/
│   ├── app/                    # Next.js app directory
│   │   ├── dashboard/          # Dashboard page
│   │   ├── groups/             # Group management pages
│   │   ├── profile/            # User profile
│   │   └── page.tsx            # Landing/auth page
│   ├── components/             # React components
│   │   ├── modals/             # Dialog components
│   │   ├── pages/              # Page-specific components
│   │   ├── layout/             # Layout components
│   │   └── ui/                 # UI components (Radix/shadcn)
│   ├── context/                # React context providers
│   │   └── AuthContext.tsx     # Authentication state
│   ├── hooks/                  # Custom React hooks
│   │   ├── data/               # Data fetching hooks
│   │   └── calculations/       # Calculation hooks
│   ├── lib/                    # Utilities and helpers
│   │   ├── utils/              # Utility functions
│   │   ├── firebase.ts         # Firebase configuration
│   │   └── types.ts            # TypeScript types
│   └── ai/                     # AI features (Genkit)
├── public/                     # Static assets
├── .env.example                # Environment variables template
├── next.config.ts              # Next.js configuration
├── tailwind.config.ts          # Tailwind CSS configuration
└── tsconfig.json               # TypeScript configuration

---

🛠️ Tech Stack

Frontend

• Framework: Next.js 15 with Turbopack
• Language: TypeScript
• Styling: Tailwind CSS
• UI Components: Radix UI + shadcn/ui
• Icons: Lucide React
• Forms: React Hook Form + Zod
• Charts: Recharts

Backend & Database

• BaaS: Firebase
• Database: Firestore (NoSQL)
• Authentication: Firebase Auth
• Hosting: Firebase Hosting / Vercel

Development

• Package Manager: npm
• Linting: ESLint
• Type Checking: TypeScript

---

🎯 Key Features Explained

1. Real-time Expense Tracking

• Create bills and split them among group members
• Support for equal splits or custom amounts
• Track who owes whom with real-time balance updates

2. Group Management

• Create multiple groups for different friend circles
• Add/remove members dynamically
• View group analytics and spending patterns

###3. Smart Balances

• Automatic calculation of who owes whom
• Simplified settlement suggestions
• Direct friend-to-friend expenses

4. Activity Feed

• Track all group activities
• See who added what expense
• Monitor settlements and payments

5. User Profiles

• Manage personal information
• View expense history
• Track all group memberships

---

🔒 Security

This project implements several security best practices:

• ✅ Environment variables for sensitive data
• ✅ Firebase security rules for database access control
• ✅ User-friendly error messages (no system info leakage)
• ✅ Input validation with Zod
• ✅ Password reset functionality
• ⚠️ See SECURITY.md for details

Important: Never commit .env.local or any files containing secrets!

---

📚 Documentation

• Security Audit - Security considerations
• Contributing Guide - How to contribute
• Code of Conduct - Community guidelines
• Architecture - System design
• API Documentation - Firebase integration

---

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

🐛 Bug Reports & Feature Requests

Found a bug? Have a feature idea? Please open an issue!

Security Issues

Please report security vulnerabilities to pavankumar6cs@gmail.com instead of opening public issues.

---

📝 Scripts

# Development
npm run dev          # Start development server (port 9002)

# Building
npm run build        # Build for production
npm start            # Start production server

# Code Quality
npm run lint         # Run ESLint
npm run typecheck    # Run TypeScript compiler check

# AI Features (optional)
npm run genkit:dev   # Start Genkit development

---

🌐 Deployment

Vercel (Recommended)

1. Push your code to GitHub
2. Import your repository in Vercel
3. Add environment variables in Vercel dashboard
4. Deploy!

Firebase Hosting

# Install Firebase CLI
npm install -g firebase-tools

# Login to Firebase
firebase login

# Initialize hosting
firebase init hosting

# Deploy
npm run build
firebase deploy

---

🗺️ Roadmap

• Basic expense tracking
• Group management
• Real-time updates
• User authentication
• Analytics dashboard
• Dark mode
• Push notifications
• Export to CSV/PDF
• Multiple currencies
• Receipt scanning (AI)
• Mobile app (React Native)

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

👏 Acknowledgments

• Next.js - The React framework
• Firebase - Backend infrastructure
• shadcn/ui - Beautiful UI components
• Radix UI - Accessible primitives
• Vercel - Deployment platform

---

📧 Contact

Pavan Kumar - @pavan6cs - pavankumar6cs@gmail.com

Project Link: https://github.com/pavan6cs/SwiftSplit

---

⭐ Star History

If you find this project useful, please consider giving it a star!

---

Made with ❤️ by Pavan Kumar