https://github.com/dorianim/money-balancer
A simple application for managing debt with your friends!
https://github.com/dorianim/money-balancer
hacktoberfest money money-manager moneytracker pwa react rust webapp
Last synced: 18 days ago
JSON representation
A simple application for managing debt with your friends!
- Host: GitHub
- URL: https://github.com/dorianim/money-balancer
- Owner: dorianim
- License: agpl-3.0
- Created: 2022-09-09T16:28:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-02T15:20:18.000Z (about 2 years ago)
- Last Synced: 2025-03-28T01:48:14.902Z (about 1 month ago)
- Topics: hacktoberfest, money, money-manager, moneytracker, pwa, react, rust, webapp
- Language: Rust
- Homepage:
- Size: 1.54 MB
- Stars: 142
- Watchers: 3
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
money-balancer
Have you ever been on a group trip and lost track of who paid for what and who owes money to whom? If so, money balancer is the perfect tool for you! It helps you to keep track of who paid for what and calculates your balance with all of your friends. A demo is available [here](https://money-balancer.gentlemeadow-7beeb17b.northeurope.azurecontainerapps.io/#/login) but it may be reset at any time.
# Screenshots
# Usage
Using `docker-compose`:
```yaml
version: "3"
services:
money-balancer:
image: ghcr.io/dorianim/money-balancer
restart: unless-stopped
ports:
- 8000:8000
volumes:
- ./data:/data
environment:
- MONEYBALANCER_JWT_SECRET=some_super_secret_secret
```
Using `docker`:
```bash
docker run -p8000:8000 -e MONEYBALANCER_JWT_SECRET=some_super_secret_secret -v $(pwd)/data:/data ghcr.io/dorianim/money-balancer
```
You can then access money-balancer on [`http://localhost:8000`](http://localhost:8000). The API documentation can be found at [`http://localhost:8000/api/v1`](http://localhost:8000/api/v1).
# Config options
## General
- `MONEYBALANCER_JWT_SECRET`: a random value for the JWT signature
## Authentication
### Local
- `MONEYBALANCER_AUTH_LOCAL_ENABLED`: enable local username/password authentication
### Proxy
Proxy authentication can be used with services like [Authelia](https://www.authelia.com/) and [Authentik](https://goauthentik.io)
- `MONEYBALANCER_AUTH_PROXY_ENABLED`: enable proxy authentication
- `MONEYBALANCER_AUTH_PROXY_HEADERS_USERNAME`: header containing the username (e.g. `X-authentik-username`)
- `MONEYBALANCER_AUTH_PROXY_HEADERS_NICKNAME`: header containing the nickname (e.g. `X-authentik-name`)
If you want to use another sign on method, you may only protect the route `/api/v1/auth/proxy`.
For example in [Authentik](https://goauthentik.io), you may use this as the unauthenticated paths:
```
^([^p]|p(p|r(p|o(p|xp)))*([^pr]|r([^op]|o([^px]|x[^py]))))*(p(p|r(p|o(p|xp)))*(r(o?|ox))?)?$
```
(excludes everything that contains `proxy`, generated with [this tool](https://www.formauri.es/personal/pgimeno/misc/non-match-regex/?word=proxy))
# How debts are split up:
- amount / debtors
- the potential rest is assigned to people who have to overpay
- who has to overpay is determined by how often they have overpaid in the past in this specific group
# Development
You need `cargo` and `yarn` installed on your system. You can build everything using
```
cargo build
```
This will create a static binary in `target/debug/money-balancer` which you can run.