spliit

Split 是 Splitwise 的免費開源替代品。您可以使用 Spliit.app 上的官方實例，也可以部署您自己的實例：

特徵

• 建立群組並與朋友分享
• 創建費用並附上說明
• 顯示群組餘額
• 建立報銷費用
• 漸進式網頁應用程式
• 選擇所有/不選擇費用參與者
• 費用分配不均（#6）
• 將某個群組標記為最喜歡的群組 (#29)
• 打開群組時告訴應用程式您是誰（#7）
• 為費用分配類別 (#35)
• 搜尋組中的支出 (#51)
• 上傳圖像並將其附加到費用中 (#63)
• 透過掃描收據創建費用 (#23)

可能傳入的功能

• 產生經常性費用的能力（#5）
• 從 Splitwise 導入費用 (#22)

堆疊

• 用於 Web 應用程式的 Next.js
• TailwindCSS 用於樣式設定
• shadcn/UI 用於 UI 元件
• Prisma存取資料庫
• Vercel 用於託管（應用程式和資料庫）

貢獻

本項目開放供稿。請隨意提出問題甚至拉取請求！

如果您想捐款並幫助我們保持應用程式免費且無廣告，您還可以：

• ？贊助我（塞巴斯蒂安），或者
• ？進行一筆小額一次性捐款。

本地運行

1. 克隆存儲庫（如果您打算貢獻，則分叉它）
2. 啟動 PostgreSQL 伺服器。如果您還沒有伺服器，可以執行./scripts/start-local-db.sh 。
3. 將檔案.env.example複製為.env
4. 執行npm install以安裝相依性。這也將應用資料庫遷移並更新 Prisma 客戶端。
5. 運行npm run dev啟動開發伺服器

在容器中運行

1. 運行npm run build-image從 Dockerfile 建置 docker 映像
2. 將檔案container.env.example複製為container.env
3. 運行npm run start-container來啟動 postgres 和 split2 容器
4. 您可以透過瀏覽 http://localhost:3000 來存取該應用程式

選擇加入功能

費用文件

Spliit 允許使用者上傳映像（到 AWS S3 儲存桶）並將其附加到費用中。若要啟用此功能：

• 依照 next-s3-upload 的S3 儲存桶和IAM 使用者部分中的說明建立和設定用於儲存影像的 S3 儲存桶。
• 使用適當的值更新您的環境變數：

 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

您也可以透過提供自訂端點來使用其他 S3 提供者：

 S3_UPLOAD_ENDPOINT = http://localhost:9000

從收據創建費用

您可以讓用戶透過上傳收據來建立費用。此功能依賴具有 Vision 的 OpenAI GPT-4 和公共 S3 儲存端點。

若要啟用該功能：

• 您還必須啟用費用憑證功能（請參閱上面的部分）。這將來可能會改變，但現在我們需要儲存影像才能使收據掃描工作。
• 訂閱 OpenAI API 並透過 Vision 存取 GPT 4（您可能需要提前購買積分）。
• 使用適當的值更新您的環境變數：

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

從標題推斷類別

您可以讓使用者自動從標題推斷出費用類別。由於此功能依賴 OpenAI 訂閱，因此請按照上面的註冊說明進行操作並配置以下環境變數：

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

執照

麻省理工學院，請參閱許可證。