Skip to content

Latest commit

 

History

History
125 lines (81 loc) · 3.2 KB

README.md

File metadata and controls

125 lines (81 loc) · 3.2 KB
Raw

Petty Cash

Split bills like a boss.

What is Petty Cash?

Petty Cash is a simple and intuitive expense-splitting app that helps you and your squad settle bills without the drama. Whether you're sharing a pizza, splitting drinks, or going all-in on a group trip, Petty Cash has got your back with multiple split methods to keep it fair and fabulous. 💸

Features

  • Itemized Splits: Pay only for what you ordered. No more covering your friend's triple mojito spree.
  • Dutch Splits: Divide the total bill equally among all participants. Simple and stress-free.
  • Attendance-Based Splits: Share the cost of group items (like wine) only among those who enjoyed them.
  • Custom Splits: Assign custom percentages to each participant for maximum flexibility.
  • Real-Time Calculations: Get instant payment summaries as you add items and participants.
  • Responsive, Sleek Interface: Works beautifully on desktop and mobile browsers.

Tech Stack

  • HTML5: For semantic and accessible structure.
  • CSS3: For stylish, responsive design.
  • Vanilla JavaScript: For all the interactivity without the overhead of frameworks.

Getting Started

Clone the repo:

git clone git@github.com:familieslifedev/petty-cash.git
cd petty-cash

Open the app:

Simply open index.html in your browser. No build tools, no hassle!

Optional: Run a local server

If you want a local server (to avoid cross-origin issues):

npx serve

Usage

  1. Open the app in your browser.
  2. Add participants and items to the bill.
  3. Select a splitting method:
    • Itemized: Assign each item to specific participants.
    • Dutch: Split the total bill equally.
    • Attendance-Based: Share items among selected participants.
    • Custom: Set custom percentages for each participant.
  4. Review the real-time payment summary.
  5. Export or save your results (optional).

File Structure

petty-cash/
├── index.html        # Main app file
├── styles.css        # CSS for styling the app
├── script.js         # Core JavaScript logic
└── service-worker.js # Service worker for offline support

Contributing

Want to make Petty Cash even better? Feel free to contribute!

Fork the repo:

git fork https://github.com/your-username/petty-cash.git

Create a feature branch:

git checkout -b feature/amazing-feature

Submit a pull request:

Open a PR explaining your feature or fix, and let's make it happen!

Planned Features

  • Tax and Tip Calculations: Automatically add tax and tip for your region.
  • Export Options: Save results as a PDF or CSV.
  • Dark Mode: Because we all need a little moody aesthetic.
  • Offline Mode: Use the app even without an internet connection.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgments

  • Plain HTML/JS/CSS for keeping it light and accessible.
  • You, for being fabulous enough to check out Petty Cash. ✨

Now go on, be the financial hero your group deserves. Petty Cash has got you covered! 💸