SplitPro项目安装与配置指南

SplitPro项目安装与配置指南

1. 项目基础介绍

SplitPro是一个开源项目，旨在提供一个Splitwise的替代方案，帮助用户与朋友之间分享开销。它具备Splitwise的大多数重要功能，如个人或团体添加开销、支持多种货币、上传开销账单、PWA支持、不等额分摊开销等。

主要编程语言：TypeScript 和 JavaScript。

2. 项目使用的关键技术和框架

• NextJS: 用于构建服务端渲染的React应用程序。
• Tailwind: 一个功能类优先的CSS框架，用于快速UI开发。
• tRPC: 用于在客户端和服务器之间进行类型安全的远程过程调用。
• ShadcnUI: 一套高质量的React UI组件。
• Prisma: 一个数据库工具集，用于类型安全的数据访问。
• Postgres: 一个功能强大的开源对象关系型数据库系统。
• NextAuth: 一个用于Next.js的认证解决方案。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 安装Node.js（版本要求：>=18.x）。
• 安装PostgreSQL数据库。
• 安装pnpm（推荐），作为JavaScript项目的包管理器。
• 安装Docker，用于容器化应用程序。

安装步骤

1. 克隆项目到本地

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

2. 安装项目依赖

pnpm install

3. 配置环境变量

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

cp .env.example .env

4. 设置认证

根据需要设置Google OAuth或Email认证提供者。如果使用Google OAuth，请按照NextAuth文档进行配置。

5. 设置MinIO

使用splitpro用户和密码登录MinIO控制台，创建访问密钥，并设置与R2相关的环境变量。

6. 运行应用程序

pnpm dev

按照以上步骤操作，您就可以成功安装并配置SplitPro项目了。在开发环境中，您可以通过浏览器访问http://localhost:3000来查看应用程序。