https://github.com/leozqin/venmo-calculator
A simple way to split a bill with your friends
https://github.com/leozqin/venmo-calculator
css docker docker-compose golang javascript venmo vite vue vuejs
Last synced: 3 months ago
JSON representation
A simple way to split a bill with your friends
- Host: GitHub
- URL: https://github.com/leozqin/venmo-calculator
- Owner: leozqin
- Created: 2024-06-30T01:51:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T01:39:11.000Z (almost 2 years ago)
- Last Synced: 2025-04-23T21:02:14.610Z (about 1 year ago)
- Topics: css, docker, docker-compose, golang, javascript, venmo, vite, vue, vuejs
- Language: Vue
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# venmo-calculator
This is a simple app that helps you split a bill with your friends (presumably via venmo request). This app is meant to be self-hosted and we provide a docker compose stack to make deployment simple.
In keeping with the simplicity, no persistent storage is supported or required.
Proportionality is achieved by calculating the proportion of the pre tax, tip, or fee subtotal attributable to each person, and then distributing the final total (post-tax, tip, or fee) using that calculation.
## Architecture/Technologies
- This app is designed to deploy via docker-compose.
- The backend is written in `golang` and uses the `chi` router - [(repo here)](https://github.com/go-chi/chi)
- The frontend is a simple SPA written in javascript using the [vue.js](https://vuejs.org/) framework and built using [Vite](https://vitejs.dev/) and styled using vanilla CSS in component scoped styles (thanks, vue!)
## Deployment
When you decide what the URL for your instance of this app will be, [modify this file](./web/.env.production) with the appropriate base URL.
You'll also need to change the `WEB_URL` environment variable in the [docker-compose.yml](docker-compose.yml).
Then - simply start the docker compose stack:
```
docker compose up -d
```
## Development
- The frontend comes with its own dev instructions, which require `npm`. I recommend managing your `npm` versions using [nvm](https://github.com/nvm-sh/nvm)
- The backend is an uncomplicated `golang` app - I've historically managed `golang` versions using [gvm](https://github.com/moovweb/gvm), but for this product I tried using [g](https://github.com/stefanmaric/g) and enjoyed it.