/Eat-n-Split

A web application built with React to simplify the process of splitting bills among friends.

Primary LanguageJavaScriptMIT LicenseMIT

Eat-n-Split

Eat-n-Split is a user-friendly web application built with React that simplifies the process of splitting bills among friends. Whether you're dining out, sharing expenses, or keeping track of balances, Eat-n-Split makes it easy to manage and settle bills fairly.

image

Features

  • Friend Management: Easily add friends to your list, including their name and profile image.
  • Balance Tracking: Keep track of balances with each friend, clearly displaying who owes whom and the respective amounts.
  • Bill Splitting: Split bills effortlessly by entering the total bill amount, specifying your share, and selecting the person who paid the bill. Eat-n-Split automatically calculates and updates the balances accordingly.

Getting Started

To run Eat-n-Split locally on your machine, follow these steps:

  1. Clone the repository:

    git clone https://github.com/lemonteaau/Eat-n-Split.git

  2. Navigate to the project directory:

    cd Eat-n-Split

  3. Install the dependencies:

    npm install

  4. Start the development server:

    npm start

  5. Open your browser and visit http://localhost:3000 to access Eat-n-Split.

Usage

  1. Add friends to your list by clicking the Add button and providing their name and image URL.
image
  1. Select a friend from the list to view their balance and split a bill with them.
  2. Enter the total bill amount, specify your expense, and choose who paid the bill.
  3. Click the Split bill button to calculate and update the balances.
image
  1. The app will display the updated balances, indicating who owes whom and the respective amounts.

Contributing

Contributions to Eat-n-Split are welcome! If you find any bugs, have suggestions for improvements, or would like to add new features, please open an issue or submit a pull request.

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request detailing your changes.

Credit

This project is based on a project from JONAS SCHMEDTMANN's "The Ultimate React Course". The course provided the foundation and guidance for building this app.

License

This project is licensed under the MIT license.