SplitPro 开源项目教程

SplitPro 开源项目教程

split-pro Open source alternative to Splitwise 项目地址: https://gitcode.com/gh_mirrors/sp/split-pro

1. 项目介绍

SplitPro 是一个开源的共享费用管理工具，旨在提供一个替代 Splitwise 的解决方案。它支持用户添加个人或团队的费用，管理跨团队的总体余额，并支持多种货币。SplitPro 还允许用户上传费用账单，不平等地分割费用（通过份额、百分比、确切金额或调整），并且具备推送通知、数据导出以及从 Splitwise 导入数据等功能。

该项目使用了一系列现代技术栈，包括 NextJS、Tailwind、tRPC、ShadcnUI、Prisma 和 PostgreSQL，旨在提供一个功能完善且易于使用的应用程序。

2. 项目快速启动

环境准备

• Node.js (版本 >=18.x)
• PostgreSQL
• pnpm (推荐)
• Docker

启动步骤

1. 克隆项目到本地：

   git clone https://github.com/oss-apps/split-pro.git
   cd split-pro
   

2. 安装依赖：

   pnpm i
   

3. 配置环境变量：

   将 env.example 文件复制为 .env 文件，并设置相应的数据库、Redis、AWS 等环境变量。

4. 设置身份验证：

   根据需要设置 Google OAuth 或 Email 提供商的 SMTP 详细信息。

5. 在 Minio 控制台使用用户名 splitpro 和密码 password 登录，并创建访问密钥以及相关的 R2 环境变量。

6. 运行应用程序：

   pnpm d
   

3. 应用案例和最佳实践

• 个人财务管理：使用 SplitPro 管理个人日常开支，跟踪收入和支出。
• 团队费用分摊：在团队项目中，SplitPro 可以帮助团队成员分摊费用，并清晰记录每个人的贡献和欠款情况。
• 活动组织：组织活动时，SplitPro 可以用于收集参与者的费用，并自动计算分摊金额。

4. 典型生态项目

SplitPro 作为开源项目，可以与其他开源工具集成，例如：

• 自动化工作流程：结合 GitHub Actions，自动化项目的部署和测试。
• 持续集成和持续部署 (CI/CD)：使用 Jenkins、GitLab CI 等工具实现项目的持续集成和持续部署。
• 安全性：通过集成 GitHub Advanced Security 或其他安全工具，提高项目的安全性。

以上是 SplitPro 的基本教程，希望对您有所帮助。

split-pro Open source alternative to Splitwise 项目地址: https://gitcode.com/gh_mirrors/sp/split-pro