Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Eat-n'-Split

This is a simple React application designed to help track expenses among friends when dining out together. It displays a list of friends along with their current balances, indicating who owes whom.

How It Works

The application consists of a sidebar displaying a list of friends and their balances. Each friend's balance is represented by their name, profile picture, and an indication of whether they owe money or are owed money. If the balance is negative, it means the friend owes money, and if it's positive, it means they are owed money. A balance of zero indicates that the friends are even.

Features

  • Friend List: Displays a list of friends along with their balances.
  • Balance Indicator: Indicates whether each friend owes money or is owed money.
  • Interaction: Provides a button to select a friend, which can be further extended for interaction, like settling debts or adding new expenses.

Usage

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install.
  3. Start the development server with npm start.
  4. Access the application in your browser at http://localhost:3000.

Technologies Used

  • React: Frontend JavaScript library for building user interfaces.
  • JavaScript (ES6+): Programming language for building web applications.
  • HTML/CSS: Markup and styling for the user interface.

How to Contribute

Contributions to the Splitwise React App are encouraged and welcome! If you'd like to contribute, please follow these steps:

  1. Fork the Repository: Fork the repository to your GitHub account by clicking the "Fork" button at the top right of the repository page. This will create a copy of the project in your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine using Git.

    git clone https://github.com/Macmilan24/Eat-n-Split.git
  3. Create a Branch: Create a new branch to work on your changes. Use a descriptive name for the branch that reflects the purpose of your changes.

    git checkout -b feature/new-feature
  4. Make Changes: Make your desired changes to the codebase. This could include bug fixes, new features, improvements to existing features, or documentation updates.

  5. Test Your Changes: Ensure that your changes work as expected and do not introduce any new issues. Run any necessary tests to verify the functionality of the application.

  6. Commit Your Changes: Once you're happy with your changes, commit them to your branch with descriptive commit messages.

    git add .
    git commit -m "Add new feature: description of changes"
  7. Push Your Changes: Push your changes to your forked repository on GitHub.

    git push origin feature/new-feature
  8. Submit a Pull Request: Go to the GitHub page of your forked repository and click on the "New pull request" button. Provide a descriptive title and detailed description for your pull request, explaining the changes you've made and why they're necessary.

  9. Review and Collaborate: Collaborate with other contributors and maintainers to review your pull request. Address any feedback or comments and make any necessary changes.

  10. Merge Your Pull Request: Once your pull request has been approved and all discussions are resolved, it will be merged into the main repository by a maintainer.

Thank you for contributing to the Eat-n'-Split React App!

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages