Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 1.94 KB

README.md

File metadata and controls

91 lines (67 loc) · 1.94 KB

pooli

Pooli is a shared expense management application that makes it easy to split costs among groups. Whether you're traveling, dining out, or organizing a party, Pooli ensures that everyone knows their share and payments are transparent.

Features

Group Management

  • Add members to a group.
  • Edit or delete group members.

Expense Tracking

  • Record expenses with detailed descriptions (e.g., "Lunch at the Cafe").
  • Associate each expense with one or more group members.

Debt & Credit Calculation

  • Automatic calculations for each group member.
  • Display of individual balances to show who owes whom and by how much.

Final Reports

  • Generate a final summary for settlements.
  • Export the report for offline use or sharing.

Steps

  1. Clone this repository: 
    git clone https://github.com/hadirezaei1377/pooli.git
  2. Navigate to the project directory: 
    cd pooli
  3. Build the application: 
    go build
  4. Run the application: 
    ./pooli

Usage

  1. Start the Application:
    Launch Pooli in your terminal.

  2. Add Group Members:
    Use the provided commands to add members:

    add-member "name"

  3. Record Expenses:
    Add expenses with descriptions and allocate them to group members:

    add-expense "name1" 50 "name2,name3"

  4. View Balances:
    Display the current balances:

    view-balances

  5. Generate Reports:
    Create a final report for settlements:

    generate-report

Contribution

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Submit a pull request.

License

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