Skip to content

README.md

Latest commit

 

History

History
129 lines (90 loc) · 5.56 KB

README.md

File metadata and controls

129 lines (90 loc) · 5.56 KB

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:

Deploy with Vercel

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

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.

If you want to contribute financially and help us keep the application free and without ads, you can also:

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:

Translation status

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

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

Health check

The application has a health check endpoint that can be used to check if the application is running and if the database is accessible.

  • GET /api/health/readiness or GET /api/health - Check if the application is ready to serve requests, including database connectivity.
  • GET /api/health/liveness - Check if the application is running, but not necessarily ready to serve requests.

Opt-in features

Expense documents

Spliit offers users to upload images (to an AWS S3 bucket) and attach them to expenses. To enable this feature:

  • Create an S3 bucket on AWS or any S3-compatible provider.
  • Update your environments variables with appropriate values:
NEXT_PUBLIC_ENABLE_EXPENSE_DOCUMENTS=true
S3_UPLOAD_KEY=AAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_SECRET=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_BUCKET=name-of-s3-bucket
S3_UPLOAD_REGION=us-east-1

You can also use other S3 providers by providing a custom endpoint:

S3_UPLOAD_ENDPOINT=http://localhost:9000

Create expense from receipt

You can offer users to create expense by uploading a receipt. This feature relies on a vision-enabled LLM, and S3 storage for the uploaded images.

To enable the feature:

  • You must enable expense documents feature as well (see section above). That might change in the future, but for now we need to store images to make receipt scanning work.
  • Subscribe to an OpenAI API compatible provider and get access to model with vision.
  • Update your environment variables with appropriate values:
NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT=true
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
OPENAI_IMAGE_MODEL=gpt-5-nano

Deduce category from title

You can offer users to automatically deduce the expense category from the title. Since this feature relies on a OpenAI subscription, follow the signup instructions above and configure the following environment variables:

NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT=true
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
OPENAI_TEXT_MODEL=gtp3.5-turbo

License

MIT, see LICENSE.