{"id":13815799,"url":"https://github.com/spliit-app/spliit","last_synced_at":"2025-04-23T16:17:09.262Z","repository":{"id":211935585,"uuid":"727945243","full_name":"spliit-app/spliit","owner":"spliit-app","description":"Free and Open Source Alternative to Splitwise. Share expenses with your friends and family.","archived":false,"fork":false,"pushed_at":"2025-04-20T15:10:33.000Z","size":1226,"stargazers_count":1538,"open_issues_count":126,"forks_count":244,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-23T16:17:01.869Z","etag":null,"topics":["nextjs","react","shadcn-ui","splitwise","tailwindcss","template","tricount","vercel"],"latest_commit_sha":null,"homepage":"https://spliit.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spliit-app.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["scastiel"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://donate.stripe.com/28o3eh96G7hH8k89Ba"]}},"created_at":"2023-12-05T22:40:06.000Z","updated_at":"2025-04-23T08:54:12.000Z","dependencies_parsed_at":"2024-02-28T16:50:27.503Z","dependency_job_id":"4f1cbc38-e44a-444e-b54f-827fc66d57af","html_url":"https://github.com/spliit-app/spliit","commit_stats":null,"previous_names":["scastiel/spliit2","spliit-app/spliit"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spliit-app%2Fspliit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spliit-app%2Fspliit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spliit-app%2Fspliit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spliit-app%2Fspliit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spliit-app","download_url":"https://codeload.github.com/spliit-app/spliit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250468277,"owners_count":21435453,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","react","shadcn-ui","splitwise","tailwindcss","template","tricount","vercel"],"created_at":"2024-08-04T04:04:04.325Z","updated_at":"2025-04-23T16:17:09.245Z","avatar_url":"https://github.com/spliit-app.png","language":"TypeScript","readme":"[\u003cimg alt=\"Spliit\" height=\"60\" src=\"https://github.com/spliit-app/spliit/blob/main/public/logo-with-text.png?raw=true\" /\u003e](https://spliit.app)\n\nSpliit is a free and open source alternative to Splitwise. You can either use the official instance at [Spliit.app](https://spliit.app), or deploy your own instance:\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fspliit-app%2Fspliit\u0026project-name=my-spliit-instance\u0026repository-name=my-spliit-instance\u0026stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D\u0026)\n\n## Features\n\n- [x] Create a group and share it with friends\n- [x] Create expenses with description\n- [x] Display group balances\n- [x] Create reimbursement expenses\n- [x] Progressive Web App\n- [x] Select all/no participant for expenses\n- [x] Split expenses unevenly [(#6)](https://github.com/spliit-app/spliit/issues/6)\n- [x] Mark a group as favorite [(#29)](https://github.com/spliit-app/spliit/issues/29)\n- [x] Tell the application who you are when opening a group [(#7)](https://github.com/spliit-app/spliit/issues/7)\n- [x] Assign a category to expenses [(#35)](https://github.com/spliit-app/spliit/issues/35)\n- [x] Search for expenses in a group [(#51)](https://github.com/spliit-app/spliit/issues/51)\n- [x] Upload and attach images to expenses [(#63)](https://github.com/spliit-app/spliit/issues/63)\n- [x] Create expense by scanning a receipt [(#23)](https://github.com/spliit-app/spliit/issues/23)\n\n### Possible incoming features\n\n- [ ] Ability to create recurring expenses [(#5)](https://github.com/spliit-app/spliit/issues/5)\n- [ ] Import expenses from Splitwise [(#22)](https://github.com/spliit-app/spliit/issues/22)\n\n## Stack\n\n- [Next.js](https://nextjs.org/) for the web application\n- [TailwindCSS](https://tailwindcss.com/) for the styling\n- [shadcn/UI](https://ui.shadcn.com/) for the UI components\n- [Prisma](https://prisma.io) to access the database\n- [Vercel](https://vercel.com/) for hosting (application and database)\n\n## Contribute\n\nThe project is open to contributions. Feel free to open an issue or even a pull-request!\n\nIf you want to contribute financially and help us keep the application free and without ads, you can also:\n\n- 💜 [Sponsor me (Sebastien)](https://github.com/sponsors/scastiel), or\n- 💙 [Make a small one-time donation](https://donate.stripe.com/28o3eh96G7hH8k89Ba).\n\n## Run locally\n\n1. Clone the repository (or fork it if you intend to contribute)\n2. Start a PostgreSQL server. You can run `./scripts/start-local-db.sh` if you don’t have a server already.\n3. Copy the file `.env.example` as `.env`\n4. Run `npm install` to install dependencies. This will also apply database migrations and update Prisma Client.\n5. Run `npm run dev` to start the development server\n\n## Run in a container\n\n1. Run `npm run build-image` to build the docker image from the Dockerfile\n2. Copy the file `container.env.example` as `container.env`\n3. Run `npm run start-container` to start the postgres and the spliit2 containers\n4. You can access the app by browsing to http://localhost:3000\n\n## Opt-in features\n\n### Expense documents\n\nSpliit offers users to upload images (to an AWS S3 bucket) and attach them to expenses. To enable this feature:\n\n- Follow the instructions in the _S3 bucket_ and _IAM user_ sections of [next-s3-upload](https://next-s3-upload.codingvalue.com/setup#s3-bucket) to create and set up an S3 bucket where images will be stored.\n- Update your environments variables with appropriate values:\n\n```.env\nNEXT_PUBLIC_ENABLE_EXPENSE_DOCUMENTS=true\nS3_UPLOAD_KEY=AAAAAAAAAAAAAAAAAAAA\nS3_UPLOAD_SECRET=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\nS3_UPLOAD_BUCKET=name-of-s3-bucket\nS3_UPLOAD_REGION=us-east-1\n```\n\nYou can also use other S3 providers by providing a custom endpoint:\n\n```.env\nS3_UPLOAD_ENDPOINT=http://localhost:9000\n```\n\n### Create expense from receipt\n\nYou can offer users to create expense by uploading a receipt. This feature relies on [OpenAI GPT-4 with Vision](https://platform.openai.com/docs/guides/vision) and a public S3 storage endpoint.\n\nTo enable the feature:\n\n- 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.\n- Subscribe to OpenAI API and get access to GPT 4 with Vision (you might need to buy credits in advance).\n- Update your environment variables with appropriate values:\n\n```.env\nNEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT=true\nOPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX\n```\n\n### Deduce category from title\n\nYou 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:\n\n```.env\nNEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT=true\nOPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX\n```\n\n## License\n\nMIT, see [LICENSE](./LICENSE).\n","funding_links":["https://github.com/sponsors/scastiel","https://donate.stripe.com/28o3eh96G7hH8k89Ba"],"categories":["Personal Finances","TypeScript","Recently Updated","Platforms \u0026 Applications","nextjs"],"sub_categories":["Shared Expenses","[Who Wants to Be a Millionare](https://www.boardgamecapital.com/who-wants-to-be-a-millionaire-rules.htm)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspliit-app%2Fspliit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspliit-app%2Fspliit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspliit-app%2Fspliit/lists"}