Files
spliit/README.md
Sebastien Castiel 6bd99d9a34 Update README
2023-12-13 12:31:36 -05:00

1.2 KiB
Raw Blame History

Spliit

Spliit is a free and open source alternative to Splitwise. I created it back in 2022 as a side project to learn the Go language, but rewrote it with Next.js since.

Features

  • Create a group and share it with friends
  • Create expenses with description
  • Display group balances
  • Create reimbursement expenses
  • Progressive Web App
  • Select all/no participant for expenses

Work in progress

  • Tell the application who you are when opening a group

Stack

Contribute

The project is open to contributions. Feel free to open an issue or even a pull-request!

Run locally

  1. Clone the repository (or fork it if you intend to contribute)
  2. npm install
  3. Start a PostgreSQL server. You can run ./start-local-db.sh if you dont have a server already.
  4. Copy the file .env.example as .env
  5. npm run dev

License

MIT, see LICENSE.