SplitBuddy 💸

A Community-Driven Open Source Expense Sharing App

---

🚀 Overview

SplitBuddy is an open-source alternative to Splitwise, built by the iOS Labs community.
Our mission is to create a meaningful, impactful, and production-grade product that helps people easily manage shared expenses with friends, roommates, colleagues, or travel groups.

Unlike typical “just another app” clones, SplitBuddy is designed to be:

• Educational → Built with modern Apple-recommended frameworks, patterns, and tools.
• Practical → A real solution to real-world daily problems.
• Collaborative → A community project where anyone can contribute, learn, and grow.

---

🛠️ Tech Stack

We are following best practices with a pure Swift ecosystem:

• SwiftUI → Declarative UI
• TCA (The Composable Architecture) → Scalable architecture & state management
• Combine & Swift Concurrency (async/await) → Reactive & structured concurrency
• SwiftData / CoreData → Local persistence
• RESTful APIs (planned) → For sync and future cloud support
• Unit + Snapshot Tests → Reliability & CI/CD ready

---

🎯 Features (Planned Roadmap)

✅ Core expense tracking
✅ Group creation & member management
✅ Equal & custom split options
✅ Debt settlement summary
🔜 Notifications & reminders
🔜 Multi-currency support
🔜 Analytics & insights
🔜 Cloud sync + authentication

---

📚 Learning Goals

By contributing, you’ll get hands-on with:

• Modern iOS patterns (TCA, Swift Concurrency, SwiftUI best practices)
• Real-world collaboration workflows (GitHub Issues, PR reviews, Agile sprints)
• Open source contribution etiquette
• Preparing portfolio-ready contributions for LinkedIn & GitHub

---

👩‍💻 How to Contribute

We ❤️ contributions! Here’s how you can join the journey:

1. Fork the repo

2. Clone locally

   git clone https://github.com/ios-labs/SplitBuddy.git
   

3. Open in Xcode (Latest Stable Version recommended)

4. Pick an issue from our Issue Tracker or create a new one.

5. Create a feature branch and push your changes:

   git checkout -b feature/your-feature-name
   git commit -m "Add: your feature"
   git push origin feature/your-feature-name 
   

6. Submit a PR 🚀