PAY-ME-BACK

Simplify Sharing, Amplify Trust, Master Your Finances

Built with the tools and technologies:

---

Table of Contents

• Overview
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing

---

Overview

pay-me-back is an open-source platform that simplifies the development of trip expense sharing applications. It combines a robust backend API with a feature-rich iOS frontend, enabling seamless collaboration, expense tracking, and settlement management.

Why pay-me-back?

This project helps developers build reliable, scalable expense management solutions with integrated testing, data modeling, and intuitive user interfaces. The core features include:

• 🧪 Test Automation: Comprehensive API endpoint testing ensures backend stability and correctness.
• ⚙️ Core API: Manages group creation, expense tracking, and balance calculations for collaborative trip planning.
• 🗃️ Database Schema: Defines structured data models for users, groups, expenses, and settlements, ensuring data integrity.
• 📱 Frontend State Management: Maintains application state and data flow for a smooth user experience.
• 🎨 UI Components: Modular views and assets support a cohesive, scalable interface across devices.
• 🔄 Cross-Platform Integration: Connects backend and frontend seamlessly for end-to-end expense sharing.

---

Getting Started

Prerequisites

This project requires the following dependencies:

• Programming Language: Swift
• Package Manager: Pip

Installation

Build pay-me-back from the source and install dependencies:

1. Clone the repository:

   ❯ git clone https://github.com/AndyG6/pay-me-back

2. Navigate to the project directory:

   ❯ cd pay-me-back

3. Install the dependencies:

Using pip:

❯ pip install -r backend/requirements.txt

Usage

Run the project with:

Using pip:

python {entrypoint}

Testing

Pay-me-back uses the {test_framework} test framework. Run the test suite with:

Using pip:

pytest

---

⬆ Return

---