快速开始
本指南将帮助你快速设置开发环境并运行 IAM 项目。
在开始之前,确保你的开发环境已安装以下工具:
- Node.js: 版本 18.20.8 或更高(推荐 20.3.0+ 或 22+)
- pnpm: 版本 7.1.0 或更高(推荐 10.20.0)
- PostgreSQL: 版本 12 或更高
- Git: 用于版本控制
1. 克隆项目
Section titled “1. 克隆项目”如果还没有克隆项目,请先克隆:
git clone <repository-url>cd IAM2. 安装依赖
Section titled “2. 安装依赖”使用 pnpm 安装所有依赖:
pnpm install3. 配置环境变量
Section titled “3. 配置环境变量”复制环境变量模板文件并重命名为 .env:
# 复制服务端环境变量cp apps/server/.env.example apps/server/.env
# 复制前端环境变量cp apps/web/.env.example apps/web/.env然后根据你的实际环境修改 .env 文件中的配置。以下是主要配置项说明:
服务端配置 (apps/server/.env)
Section titled “服务端配置 (apps/server/.env)”# 数据库配置DATABASE_URL=postgresql://user:password@localhost:5432/iam_dbDATABASE_URL_DIRECT=postgresql://user:password@localhost:5432/iam_db
# Redis 配置 (Upstash)KV_REST_API_URL=https://your-redis-instance.upstash.ioKV_REST_API_TOKEN=your-redis-token
# 认证配置BETTER_AUTH_SECRET=your-secret-key-at-least-32-characters-longBETTER_AUTH_URL=http://localhost:3000CORS_ORIGIN=http://localhost:3000
# 环境NODE_ENV=development前端配置 (apps/web/.env)
Section titled “前端配置 (apps/web/.env)”# 公共配置(用于 Next.js)NEXT_PUBLIC_SERVER_URL=http://localhost:3000重要提示:
BETTER_AUTH_SECRET必须至少 32 个字符- 确保 PostgreSQL 数据库已创建
- 配置 Upstash Redis 用于会话管理和组织功能
- 根据你的实际环境修改连接字符串
- 请勿将
.env文件提交到版本控制(已在.gitignore中忽略)
4. 初始化数据库
Section titled “4. 初始化数据库”推送数据库架构到数据库:
# 推送数据库架构pnpm run db:push或者打开数据库管理界面进行可视化操作:
pnpm run db:studio5. 启动开发服务器
Section titled “5. 启动开发服务器”启动所有应用(前端 + 后端):
pnpm run dev这将启动:
- Web 应用: http://localhost:3000
- API 服务器: http://localhost:4000
或者分别启动:
# 仅启动 Web 应用pnpm run dev:web
# 仅启动服务器pnpm run dev:server- 打开浏览器访问 http://localhost:3000
- 检查 API 服务器是否正常运行:http://localhost:4000
- 查看终端输出,确认没有错误