Reactive-Resume项目本地开发环境搭建指南

Reactive-Resume项目本地开发环境搭建指南

Reactive-Resume AmruthPillai/Reactive-Resume: 是一个基于 React 和 Firebase 的简历生成工具。适合对 Web 开发和简历制作有兴趣的人，特别是想快速生成个性化简历的人。特点是提供了一个简洁易用的界面，可以通过填充个人信息和选择模板来自动生成简历，同时支持多种格式的导出，具有高可定制性和易用性。 项目地址: https://gitcode.com/gh_mirrors/re/Reactive-Resume

前言

Reactive-Resume是一个现代化的简历构建工具，采用前后端分离架构开发。本文将详细介绍如何在本地搭建该项目的开发环境，帮助开发者快速上手项目开发工作。

环境准备

在开始之前，请确保您的开发机器满足以下基础要求：

1. Docker环境：包括Docker Compose组件
2. Node.js运行时：版本20或更高
3. pnpm包管理器：替代npm/yarn的现代化包管理工具

项目初始化步骤

第一步：获取项目代码

通过版本控制系统获取项目源代码，进入项目根目录：

git clone {项目仓库地址}
cd Reactive-Resume

第二步：安装项目依赖

使用pnpm安装所有必要的依赖项：

pnpm install

pnpm相比传统包管理器具有更快的安装速度和更高效的磁盘空间利用。

第三步：配置环境变量

复制示例环境文件并修改配置：

cp .env.example .env

打开.env文件，您可能需要调整以下常见配置项：

• 端口号（避免与本地其他服务冲突）
• 数据库连接参数
• 缓存服务配置

启动开发环境

使用Docker Compose启动服务

项目提供了多种Docker Compose配置方案，开发环境推荐使用development.yml：

docker compose -f tools/compose/development.yml --env-file .env -p reactive-resume up -d

这个命令会启动以下服务容器：

• 数据库服务（PostgreSQL）
• 缓存服务（Redis）
• 存储服务（MinIO）
• 浏览器服务（用于PDF生成）

等待约30秒后，可以使用以下命令检查服务状态：

docker compose -p reactive-resume ps

数据库迁移

在首次启动或数据库结构变更后，需要执行迁移：

pnpm prisma:migrate:dev

Prisma是一个现代化的ORM工具，负责管理数据库结构和迁移。

启动开发服务器

运行以下命令启动前后端开发服务：

pnpm dev

启动成功后：

• 前端服务运行在5173端口
• 后端API服务运行在3000端口

前端配置了代理，所有发往/api的请求会自动转发到后端服务。

验证服务状态

访问健康检查端点确认各组件状态：

curl http://localhost:3000/api/health

预期返回示例：

{
  "status": "ok",
  "info": {
    "database": { "status": "up" },
    "storage": { "status": "up" },
    "browser": { "status": "up", "version": "Chrome/119.0.6045.9" }
  }
}

开发规范建议

1. 提交信息格式：遵循Conventional Commits规范

   • 示例：fix(homepage): 修复FAQ部分的拼写错误
   • 类型可选：feat, fix, docs, style, refactor等

2. 变更管理流程：

   • 每个功能或修复应有对应的issue记录
   • 保持提交信息的清晰和描述性
   • 确保变更经过充分测试

常见问题排查

1. 端口冲突：修改.env中的PORT配置，并同步更新client代理配置
2. 数据库连接失败：检查Docker容器状态和数据库连接字符串
3. 依赖安装问题：尝试清除pnpm缓存后重新安装

通过以上步骤，您应该已经成功搭建了Reactive-Resume的本地开发环境，可以开始进行功能开发和问题修复工作了。

Reactive-Resume AmruthPillai/Reactive-Resume: 是一个基于 React 和 Firebase 的简历生成工具。适合对 Web 开发和简历制作有兴趣的人，特别是想快速生成个性化简历的人。特点是提供了一个简洁易用的界面，可以通过填充个人信息和选择模板来自动生成简历，同时支持多种格式的导出，具有高可定制性和易用性。 项目地址: https://gitcode.com/gh_mirrors/re/Reactive-Resume