An open API service indexing awesome lists of open source software.

https://github.com/whysosaket/paybackpal

A React Native application designed to simplify the task of tracking shared expenses and debts among groups of people.
https://github.com/whysosaket/paybackpal

react-native

Last synced: 3 months ago
JSON representation

A React Native application designed to simplify the task of tracking shared expenses and debts among groups of people.

Awesome Lists containing this project

README

          

# PayBackPal - Keep Track of Who Owes What

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

PayBackPal is a mobile application developed using React Native that simplifies the task of keeping track of shared expenses and who owes what to whom. Whether you're managing bills with roommates, friends, or family members, PayBackPal is your go-to solution for hassle-free expense management.

## Features

- Easily add and manage expenses
- Keep track of who owes money and who is owed
- View a summary of all shared expenses
- User-friendly and intuitive interface

## Getting Started

### Prerequisites

To run PayBackPal, you will need the following tools and dependencies installed:

- Node.js
- npm (Node Package Manager)
- React Native CLI
- Xcode (for iOS development) or Android Studio (for Android development)

### Installation

1. Clone the repository:

```bash
git clone https://github.com/whysosaket/paybackpal.git
cd paybackpal
```

2. Install the project dependencies:

```bash
npm install
```

3. Run the application:

- For iOS:

```bash
npx react-native run-ios
```

- For Android:

```bash
npx react-native run-android
```

## Usage

1. Launch the PayBackPal application on your device.

2. Create an account or log in.

3. Add expenses by specifying the details, including the amount, participants, and description.

4. The app will automatically calculate and keep track of who owes money and who is owed.

5. View summaries and history of expenses to keep everything organized.

## Contributing

We welcome contributions from the open-source community! If you'd like to contribute to PayBackPal, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix: `git checkout -b feature-name`.
3. Make your changes and commit them: `git commit -m 'Description of your changes'`.
4. Push your branch to your fork: `git push origin feature-name`.
5. Create a pull request to the `main` branch of the original repository.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact

If you have any questions, issues, or feedback, please don't hesitate to [contact us](mailto:saketaryan2002@gmail.com) or open an issue in the repository.

Follow us on Twitter: [@whysosaket](https://twitter.com/whysosaket)

Thank you for using PayBackPal!

Happy expense tracking! 📊💰