Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.24 KB

README.md

File metadata and controls

72 lines (45 loc) · 2.24 KB
Raw

Expense Share App

The Expense Share App is a web application designed to simplify the process of managing expenses within a group. It allows users to create groups, add expenses, and evenly divide the expenses among group members. Additionally, the app features a group chat functionality to facilitate communication among group members.

Features

  • Group Creation: Users can create groups and invite other members to join.
  • Expense Management: Users can add expenses to the group and categorize them.
  • Expense Division: Expenses are automatically divided equally among group members.
  • Real-time Chat: Group members can communicate with each other using the built-in chat feature.
  • User Authentication: Secure user authentication ensures that only authorized users can access the app implements Json Web Tokens (JWT).

Technologies Used

  • Frontend: React.js with Material-UI for the user interface.
  • Backend: Node.js with Express.js for the API.
  • Database: PostgreSQL
    • Object Relation Mapping: Sequelize
  • Real-time Communication: Socket.IO.

Installation

To run the Expense Share App locally, follow these steps:

  1. Clone the repository:

  2. Navigate to the project directory: cd expense-app

  3. Install dependencies for the frontend: npm install

  4. Clone backend and Install dependencies for the backend: repolink: https://github.com/roshanaale9818/SettleUp-BE.git cd backend npm i

  5. Start the backend server: npm start

  6. Start the frontend server: npm run dev

  7. Open your web browser and navigate to http://localhost:3000 to view the Expense Share App.

Usage

  1. Sign up or log in to the app.
  2. Create a group or join an existing group.
  3. Add expenses to the group and categorize them.
  4. Chat with other group members in real-time.
  5. Monitor expense division and settle debts within the group.

Contributing

Contributions to the Expense Share App are welcome! To contribute, follow these steps:

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

Contact

For questions or support, contact [[email protected]].