SplitPro Docker镜像文档

镜像概述与主要用途

SplitPro是一款开源的费用分摊工具，旨在作为Splitwise的完全替代方案，帮助用户与朋友轻松管理共享支出。它提供了与Splitwise相当的核心功能，支持个人或群组费用跟踪、多币种处理、账单上传等，适合需要透明、自主管理费用分摊的用户。

核心功能与特性

• 支出管理：支持添加个人或群组支出，记录详细费用信息
• 余额跟踪：跨群组查看整体收支余额，清晰掌握财务关系
• 多币种支持：适配不同国家/地区的货币单位，满足跨国费用分摊需求
• 账单上传：支持上传费用账单作为凭证，便于核对与记录
• PWA支持：渐进式Web应用，可在移动设备上安装使用，体验接近原生应用
• 不均等分摊：灵活支持按份额、百分比、精确金额或手动调整等多种分摊方式
• 推送通知：及时获取费用更新、分摊提醒等通知
• 数据自主权：支持下载个人数据备份，保障数据安全
• 数据迁移：可从Splitwise导入历史数据，无缝切换使用
• 持续功能迭代：更多实用功能持续开发中

使用场景与适用范围

• 日常费用分摊：与朋友、家人或室友分摊聚餐、购物、房租、水电费等日常开支
• 团体活动管理：旅行、聚会、团建等团体活动中的费用收集与分摊
• 小型组织财务：学生社团、兴趣小组等小型组织的共享费用跟踪
• 开源替代需求：对Splitwise付费功能（如核心支出添加收费）不满的用户
• 数据自主需求：希望掌控数据存储与隐私，避免依赖闭源服务的用户

使用方法与配置说明

镜像获取

SplitPro Docker镜像发布于以下两个仓库，可选择任一来源拉取：

• DockerHub：ossapps/splitpro
• GitHub Container Registry：ghcr.io/oss-apps/splitpro

拉取命令示例：

bash
# 从DockerHub拉取
docker pull ossapps/splitpro

# 从GitHub Container Registry拉取
docker pull ghcr.io/oss-apps/splitpro

环境变量配置

运行容器前需配置必要的环境变量，用于连接数据库、存储服务等。关键环境变量说明如下（完整配置请参考项目Docker目录的Docker README）：

容器部署示例

基础运行命令

使用docker run启动容器，需指定端口映射及环境变量：

bash
docker run -d \
  --name splitpro \
  -p 3000:3000 \  # 端口映射（主机端口:容器端口）
  -e DATABASE_URL="postgresql://user:password@db-host:5432/splitpro" \
  -e REDIS_URL="redis://redis-host:6379" \
  -e R2_ACCESS_KEY_ID="your-r2-access-key" \
  -e R2_SECRET_ACCESS_KEY="your-r2-secret-key" \
  -e R2_BUCKET="your-bucket-name" \
  -e R2_REGION="auto" \
  -e RESEND_API_KEY="your-resend-api-key" \
  ossapps/splitpro

环境变量文件部署

推荐使用.env文件管理环境变量，简化命令：

1. 创建.env文件并填入配置：

env
DATABASE_URL=postgresql://user:password@db-host:5432/splitpro
REDIS_URL=redis://redis-host:6379
R2_ACCESS_KEY_ID=your-r2-access-key
R2_SECRET_ACCESS_KEY=your-r2-secret-key
R2_BUCKET=your-bucket-name
R2_REGION=auto
RESEND_API_KEY=your-resend-api-key
# 其他必要环境变量...

2. 运行容器时挂载环境变量文件：

bash
docker run -d \
  --name splitpro \
  -p 3000:3000 \
  --env-file .env \
  ossapps/splitpro

注意事项

• 容器运行依赖外部服务（PostgreSQL数据库、Redis等），需确保这些服务已提前部署并可访问
• 存储服务（Cloudflare R2）用于上传账单文件，需提前注册并配置相关权限
• 邮件服务（Resend）用于发送通知，免费账户可满足基础使用需求
• 详细配置说明及高级部署指南（如Docker Compose配置）请参考项目源码中的Docker README

技术栈参考

• 前端框架：NextJS
• 样式框架：Tailwind CSS
• API架构：tRPC
• UI组件库：ShadcnUI
• ORM工具：Prisma
• 数据库：PostgreSQL
• 认证系统：NextAuth.js