Skip to content

amirsorayaei/split-expenses

Repository files navigation

Split Expenses

Split Expenses is a lightweight expense tracking application that helps you manage and track shared expenses with your friends, family, or colleagues. It simplifies the process of splitting bills and calculating each person's share, making it easier to settle debts and maintain financial transparency.

Features

  • Create and manage multiple expense groups for different occasions or purposes.
  • Add expenses with details such as the description, amount, and the individuals involved.
  • Automatically calculates the owed amounts for each person based on the expense distribution.
  • Generate summary reports to view a group's overall balance and outstanding debts.
  • Keep track of settled expenses and mark them as paid.
  • User-friendly interface with intuitive controls and easy navigation.

Installation

  1. Clone the repository:
git clone https://github.com/amirsorayaei/split-expenses.git
  1. Navigate to the project directory:
cd split-expenses
  1. Install the required dependencies:
yarn install
  1. Start the application:
yarn dev
  1. Access the application in your browser at https://localhost:3000

Usage

  • Sign up or log in to your account.
  • Create a new expense group or select an existing one.
  • Add expenses by providing the necessary details and the individuals involved.
  • View the summary report to see the current balance and outstanding debts.
  • Settle expenses by marking them as paid once the debts are settled.
  • Explore other features and customize the application to fit your needs.

Contributing

Contributions are welcome! If you would like to contribute to this project, please follow these guidelines:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Make your changes and ensure that they're properly tested.
  • Commit your changes and push them to your fork.
  • Submit a pull request with a clear description of your changes.

Contact

Amir Sorayaei: LinkedIn - Email

Project Link: https://github.com/amirsorayaei/split-expenses

Releases

No releases published

Packages

No packages published

Languages