mirror of
https://github.com/spliit-app/spliit.git
synced 2026-02-09 00:56:12 +01:00
2228415323
* Improve README instructions for local setup * Fix search functionality #61 - use 'includes' for expense filtering * Ensure expense groups with no matching expenses are hidden after filtering * Improve README instructions for local setup
2.9 KiB
2.9 KiB
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)
Possible incoming features
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!
If you want to contribute financially and help us keep the application free and without ads, you can also:
Run locally
- Clone the repository (or fork it if you intend to contribute)
- Start a PostgreSQL server. You can run
./scripts/start-local-db.shif you don’t have a server already. - Copy the file
.env.exampleas.env - Run
npm installto install dependencies. This will also apply database migrations and update Prisma Client. - Run
npm run devto start the development server
Run in a container
- Run
npm run build-imageto build the docker image from the Dockerfile - Copy the file
container.env.exampleascontainer.env - Run
npm run start-containerto start the postgres and the spliit2 containers - You can access the app by browsing to http://localhost:3000
License
MIT, see LICENSE.