mirror of
https://github.com/spliit-app/spliit.git
synced 2026-02-09 00:56:12 +01:00
fb49fb596a
* environment variable * random category draft * get category from ai * input limit and documentation * use watch * use field.name * prettier * presigned upload, readme warning, category to string util * prettier * check whether feature is enabled * use process.env * improved prompt to return id only * remove console.debug * show loader * share class name * prettier * use template literals * rename format util * prettier
110 lines
4.8 KiB
Markdown
110 lines
4.8 KiB
Markdown
[<img alt="Spliit" height="60" src="https://github.com/spliit-app/spliit/blob/main/public/logo-with-text.png?raw=true" />](https://spliit.app)
|
||
|
||
Spliit 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:
|
||
|
||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fspliit-app%2Fspliit&project-name=my-spliit-instance&repository-name=my-spliit-instance&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D&)
|
||
|
||
## Features
|
||
|
||
- [x] Create a group and share it with friends
|
||
- [x] Create expenses with description
|
||
- [x] Display group balances
|
||
- [x] Create reimbursement expenses
|
||
- [x] Progressive Web App
|
||
- [x] Select all/no participant for expenses
|
||
- [x] Split expenses unevenly [(#6)](https://github.com/spliit-app/spliit/issues/6)
|
||
- [x] Mark a group as favorite [(#29)](https://github.com/spliit-app/spliit/issues/29)
|
||
- [x] Tell the application who you are when opening a group [(#7)](https://github.com/spliit-app/spliit/issues/7)
|
||
- [x] Assign a category to expenses [(#35)](https://github.com/spliit-app/spliit/issues/35)
|
||
- [x] Search for expenses in a group [(#51)](https://github.com/spliit-app/spliit/issues/51)
|
||
- [x] Upload and attach images to expenses [(#63)](https://github.com/spliit-app/spliit/issues/63)
|
||
- [x] Create expense by scanning a receipt [(#23)](https://github.com/spliit-app/spliit/issues/23)
|
||
|
||
### Possible incoming features
|
||
|
||
- [ ] Ability to create recurring expenses [(#5)](https://github.com/spliit-app/spliit/issues/5)
|
||
- [ ] Import expenses from Splitwise [(#22)](https://github.com/spliit-app/spliit/issues/22)
|
||
|
||
## Stack
|
||
|
||
- [Next.js](https://nextjs.org/) for the web application
|
||
- [TailwindCSS](https://tailwindcss.com/) for the styling
|
||
- [shadcn/UI](https://ui.shadcn.com/) for the UI components
|
||
- [Prisma](https://prisma.io) to access the database
|
||
- [Vercel](https://vercel.com/) 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:
|
||
|
||
- 💜 [Sponsor me (Sebastien)](https://github.com/sponsors/scastiel), or
|
||
- 💙 [Make a small one-time donation](https://donate.stripe.com/28o3eh96G7hH8k89Ba).
|
||
|
||
## 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
|
||
|
||
## 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:
|
||
|
||
- 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.
|
||
- Update your environments variables with appropriate values:
|
||
|
||
```.env
|
||
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:
|
||
|
||
```.env
|
||
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 [OpenAI GPT-4 with Vision](https://platform.openai.com/docs/guides/vision) and a public S3 storage endpoint.
|
||
|
||
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 OpenAI API and get access to GPT 4 with Vision (you might need to buy credits in advance).
|
||
- Update your environment variables with appropriate values:
|
||
|
||
```.env
|
||
NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT=true
|
||
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
```
|
||
|
||
### 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:
|
||
|
||
```.env
|
||
NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT=true
|
||
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
```
|
||
|
||
## License
|
||
|
||
MIT, see [LICENSE](./LICENSE).
|