kevmegforest / my-spliit-instance Goto Github PK

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:

• 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)

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

• 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)

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:

• 💜 Sponsor me (Sebastien), or
• 💙 Make a small one-time donation.

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

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

MIT, see LICENSE.