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 

执照

麻省理工学院，请参阅许可证。