Spliit

Spliit is a free and open source alternative to Splitwise. You can either use the official instance at Spliit.app, or deploy your own instance:

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
• Split expenses unevenly (#6)
• Mark a group as favorite (#29)
• Tell the application who you are when opening a group (#7)
• Assign a category to expenses (#35)
• Search for expenses in a group (#51)
• Upload and attach images to expenses (#63)
• Create expense by scanning a receipt (#23)

Possible incoming features

• Ability to create recurring expenses (#5)
• Import expenses from Splitwise (#22)

Stack

• Next.js for the web application
• TailwindCSS for the styling
• shadcn/UI for the UI components
• Prisma to access the database
• Vercel for hosting (application and database)

Contribute

The project is open to contributions. Feel free to open an issue or even a pull-request! Join the discussion in the Spliit Discord server.

Contribute financially

Spliit is free, open source, and has no ads. Hosting, database and API costs are paid for by donations. If you want to help keep it that way, you can:

• 🧡 Support us on Open Collective — recurring or one-time, with a public and transparent ledger of what comes in and what it is spent on, or
• 💜 Sponsor me (Sebastien).

Contributions of any size are appreciated, and so is simply telling people about the project.

Translation

The project's translations are managed using our Weblate project. You can easily add missing translations to the project or even add a new language! Here is the current state of translation:

Run locally

1. Clone the repository (or fork it if you intend to contribute)
2. Start a PostgreSQL server. You can run ./scripts/start-local-db.sh if you don’t have a server already.
3. Copy the file .env.example as .env
4. Run npm install to install dependencies. This will also apply database migrations and update Prisma Client.
5. Run npm run dev to start the development server

End-to-end tests

The Playwright suite in e2e/ drives a real browser against the app running in Docker, so it exercises the same image users deploy. It needs Docker and a free port 3000, and nothing else — the stack builds itself from your checkout and throws its database away afterwards.

npm run e2e

That builds the image, starts app + PostgreSQL from compose.e2e.yaml, waits for /api/health/readiness, runs the suite and tears everything down. It never touches your development stack or ./postgres-data.

While writing tests it is quicker to keep the stack up:

npm run e2e:up                  # build and start, then leave it running
npm run e2e:test -- --ui        # iterate (also --headed, --grep, --debug)
npm run e2e:report              # open the HTML report of the last run
npm run e2e:down                # stop and delete the test database

--ui opens Playwright's UI mode, where you can pick tests, watch them run and step through a trace. It does not start the stack itself, so run npm run e2e:up first.

If port 3000 is already taken — by npm run dev, for instance — set E2E_HOST_PORT on every command of the session, including the test run:

E2E_HOST_PORT=3100 npm run e2e             # one-shot
E2E_HOST_PORT=3100 npm run e2e:up          # or, for the iteration loop
E2E_HOST_PORT=3100 npm run e2e:test -- --ui
E2E_HOST_PORT=3100 npm run e2e:down

The same suite runs in GitHub Actions from the E2E workflow, which can be triggered manually and runs automatically on release tags.

Run in a container

1. Run npm run build-image to build the docker image from the Dockerfile
2. Copy the file container.env.example as container.env
3. Run npm run start-container to start the postgres and the spliit2 containers
4. You can access the app by browsing to http://localhost:3000

Run with Docker compose

This is a sample docker-compose.yml file that you can use to deploy this web app.

This is the beginning of the README. Read the rest at the original. Read the full README ↗