SplitBill

Table of Contents

• Introduction
• Features
• Technologies
• Installation
• Usage
• Screenshots
• Contributing
• License

Introduction

SplitBill is an iOS application designed to simplify the process of splitting expenses among friends. It integrates with Firebase for backend services and offers various features to manage expenses efficiently, including authentication, CRUD operations, OCR for receipts, and integration with Venmo for payments. The app also comes with an Apple WatchOS companion app.

Features

• User Authentication: Sign in with email or phone number using Firebase Authentication.
• CRUD Operations: Create, read, update, and delete expenses and friends.
• Search Friends: Find friends by phone number or email.
• Bill Splitting: Split expenses in three different ways.
• Venmo Integration: Pay bills through Venmo, directing users to the Venmo app for transactions.
• OCR Technology: Extract necessary information from uploaded receipts.
• Apple WatchOS App: View expense lists, details, friend lists, and friend details on Apple Watch.
• Automatic Calculation: Automatically calculate the total amounts owed or to be received from friends across multiple expenses.

Technologies

• iOS Development: Swift
• Backend: Firebase (Authentication, Firestore)
• Payment Integration: Venmo API
• OCR: Optical Character Recognition for receipt processing
• Wearable: WatchOS app

Installation

1. Clone the repository:

   git clone https://github.com/JasonZe41/SplitBill.git

2. Navigate to the project directory:

   cd SplitBill

3. Open the project in Xcode:

   open SplitBill.xcodeproj

4. Install dependencies using CocoaPods:

   pod install

5. Set up Firebase:
   • Create a new Firebase project at Firebase Console.
   • Add an iOS app to your Firebase project.
   • Download the GoogleService-Info.plist file and add it to the Xcode project.

Usage

1. Run the app on an iOS simulator or device.
2. Sign up or log in using email or phone number.
3. Add friends by searching their phone number or email.
4. Create and manage expenses.
5. Split bills using the provided methods.
6. Use Venmo integration for payments.
7. Upload receipts to automatically extract expense details.
8. View and manage expenses and friends on the Apple WatchOS companion app.

Screenshots

Contributing

1. Fork the repository.
2. Create your feature branch:

   git checkout -b feature/YourFeature

3. Commit your changes:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin feature/YourFeature

5. Open a pull request.

License

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