Skip to content

快速开始

本指南将帮助你快速设置开发环境并运行 IAM 项目。

在开始之前,确保你的开发环境已安装以下工具:

  • Node.js: 版本 18.20.8 或更高(推荐 20.3.0+ 或 22+)
  • pnpm: 版本 7.1.0 或更高(推荐 10.20.0)
  • PostgreSQL: 版本 12 或更高
  • Git: 用于版本控制

如果还没有克隆项目,请先克隆:

Terminal window
git clone <repository-url>
cd IAM

使用 pnpm 安装所有依赖:

Terminal window
pnpm install

复制环境变量模板文件并重命名为 .env

Terminal window
# 复制服务端环境变量
cp apps/server/.env.example apps/server/.env
# 复制前端环境变量
cp apps/web/.env.example apps/web/.env

然后根据你的实际环境修改 .env 文件中的配置。以下是主要配置项说明:

Terminal window
# 数据库配置
DATABASE_URL=postgresql://user:password@localhost:5432/iam_db
DATABASE_URL_DIRECT=postgresql://user:password@localhost:5432/iam_db
# Redis 配置 (Upstash)
KV_REST_API_URL=https://your-redis-instance.upstash.io
KV_REST_API_TOKEN=your-redis-token
# 认证配置
BETTER_AUTH_SECRET=your-secret-key-at-least-32-characters-long
BETTER_AUTH_URL=http://localhost:3000
CORS_ORIGIN=http://localhost:3000
# 环境
NODE_ENV=development
Terminal window
# 公共配置(用于 Next.js)
NEXT_PUBLIC_SERVER_URL=http://localhost:3000

重要提示

  • BETTER_AUTH_SECRET 必须至少 32 个字符
  • 确保 PostgreSQL 数据库已创建
  • 配置 Upstash Redis 用于会话管理和组织功能
  • 根据你的实际环境修改连接字符串
  • 请勿将 .env 文件提交到版本控制(已在 .gitignore 中忽略)

推送数据库架构到数据库:

Terminal window
# 推送数据库架构
pnpm run db:push

或者打开数据库管理界面进行可视化操作:

Terminal window
pnpm run db:studio

启动所有应用(前端 + 后端):

Terminal window
pnpm run dev

这将启动:

或者分别启动:

Terminal window
# 仅启动 Web 应用
pnpm run dev:web
# 仅启动服务器
pnpm run dev:server
  1. 打开浏览器访问 http://localhost:3000
  2. 检查 API 服务器是否正常运行:http://localhost:4000
  3. 查看终端输出,确认没有错误