Skip to content

Commit 4a9bf57

Browse files
authored
Create expense from receipt (#69)
* Create expense from receipt * Add modal * Update README
1 parent 9e300e0 commit 4a9bf57

10 files changed

+657
-518
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Spliit is a free and open source alternative to Splitwise. You can either use th
1818
- [x] Assign a category to expenses [(#35)](https://github.com/spliit-app/spliit/issues/35)
1919
- [x] Search for expenses in a group [(#51)](https://github.com/spliit-app/spliit/issues/51)
2020
- [x] Upload and attach images to expenses [(#63)](https://github.com/spliit-app/spliit/issues/63)
21+
- [x] Create expense by scanning a receipt [(#23)](https://github.com/spliit-app/spliit/issues/23)
2122

2223
### Possible incoming features
2324

@@ -73,6 +74,21 @@ S3_UPLOAD_BUCKET=name-of-s3-bucket
7374
S3_UPLOAD_REGION=us-east-1
7475
```
7576

77+
### Create expense from receipt
78+
79+
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).
80+
81+
To enable the feature:
82+
83+
- 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.
84+
- Subscribe to OpenAI API and get access to GPT 4 with Vision (you might need to buy credits in advance).
85+
- Update your environment variables with appropriate values:
86+
87+
```.env
88+
NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT=true
89+
OPENAI_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
90+
```
91+
7692
## License
7793

7894
MIT, see [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)