Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 2.45 KB

README.md

File metadata and controls

84 lines (51 loc) · 2.45 KB

EachPays - Group Expense Calculator

EachPays is a Progressive Web Application (PWA) designed to simplify the way groups manage and split expenses. Built with React, Vite, and TypeScript, it offers a robust and responsive user experience, optimized for mobile devices.

Our intuitive interface ensures that whether you're planning a group trip, sharing a meal, or managing household expenses, EachPays makes it easy to keep track of who owes what.

Features

  • Mobile-First Design: Optimized for use on-the-go with a mobile-first approach.
  • PWA Capabilities: Installable on mobile devices with offline functionality for maximum convenience.
  • User-Friendly Interface: A clean, responsive interface that adjusts seamlessly across devices.
  • Real-Time Calculations: Instantly calculate individual shares of group expenses.
  • Expense History: Keep track of all group expenses in one place.
  • Secure: Uses localStorage to store data, so your group's expense data is safe.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Ensure you have Node.js installed on your system to use npm, which is necessary to install dependencies and run the project.

Installation

  1. Clone the repository:
git clone https://github.com/Jenin82/EachPays.git
cd EachPays
  1. Install project dependencies:
npm install
  1. Start the development server:
npm run dev

This will start the application in development mode with hot-reloading enabled.

  1. Open your browser and navigate to:
http://localhost:5173/

Now you can use the application from your local machine.

Deployment

To build the application for production, run the following command:

npm run build

This will generate a dist folder that you can serve using your preferred hosting solution.

Contributing

We welcome contributions to EachPays. If you have suggestions on how to improve the app, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

Contact

Jenin Joseph - @Jenin

Project Link: EachPays

Project Hosted Link: each-pays.vercel.app

Acknowledgements