OpenResume 开源简历工具新手入门指南

准备阶段

验证环境兼容性

⚠️ 注意：确保系统已安装 Node.js（v14+）和 npm（v6+）环境

【检查版本】在终端执行以下命令验证环境：

node -v  # 查看 Node.js 版本（Windows/macOS/Linux通用）
npm -v   # 查看 npm 版本（Windows/macOS/Linux通用）

获取项目源码

【克隆仓库】通过 Git 命令获取项目代码：

git clone https://gitcode.com/gh_mirrors/op/open-resume  # Windows/macOS/Linux通用

目录结构解析

项目核心文件树状结构（★表示核心程度）：

open-resume/
├── package.json        ★★★ 项目依赖配置文件
├── public/             ★★☆ 静态资源目录
│   ├── assets/         ☆☆☆ 图片和图标资源
│   └── fonts/          ☆☆☆ 字体文件
├── src/                ★★★ 源代码目录
│   ├── app/            ★★☆ 应用组件
│   │   ├── components/ ★★★ UI组件库
│   │   └── lib/        ★★☆ 工具函数库
│   └── resume-builder/ ★★★ 核心功能模块
└── next.config.js      ★★☆ Next.js配置文件

---

构建阶段

安装依赖包

【安装依赖】进入项目目录执行：

cd open-resume  # Windows/macOS/Linux通用
npm install     # Windows/macOS/Linux通用

环境变量配置

【创建配置文件】在项目根目录创建 .env.local 文件：

touch .env.local  # macOS/Linux
# 或在Windows资源管理器中手动创建文件

【配置内容】添加基础环境变量：

NEXT_PUBLIC_APP_NAME=OpenResume
NEXT_PUBLIC_DEFAULT_PORT=3000

构建项目

【开发构建】生成开发环境代码：

npm run build  # Windows/macOS/Linux通用

---

配置阶段

基础配置说明

Next.js框架（React服务端渲染解决方案）的核心配置文件位于 /open-resume/next.config.js，主要配置项：

• reactStrictMode: 启用React严格模式
• images: 图片资源处理配置
• env: 环境变量暴露设置

常见问题排查

⚠️ 注意：构建失败时优先检查Node.js版本是否符合要求

• 依赖安装失败：删除 node_modules 文件夹后重新执行 npm install
• 端口冲突：修改 .env.local 中的 NEXT_PUBLIC_DEFAULT_PORT 为其他端口
• 样式异常：检查 tailwind.config.js 文件是否存在语法错误

定制功能参数

【修改主题】编辑 /open-resume/src/app/globals.css 文件自定义样式：

/* 示例：修改主色调 */
:root {
  --primary-color: #2563eb;  /* 蓝色主题 */
}

---

运行阶段

启动开发服务器

【启动服务】执行开发模式命令：

npm run dev  # Windows/macOS/Linux通用

服务启动后访问 http://localhost:3000 即可打开应用

基础使用指南

功能模块	基础使用	进阶技巧
简历编辑	填写个人信息表单	使用快捷键 Ctrl+S 快速保存
模板选择	点击模板预览切换	自定义模板文件位于 /src/app/components/Resume/
PDF导出	点击导出按钮生成PDF	修改 /src/app/lib/redux/resumeSlice.ts 调整PDF样式

生产环境部署

【构建生产版本】

npm run build  # Windows/macOS/Linux通用

【启动生产服务】

npm start  # Windows/macOS/Linux通用

⚠️ 注意：生产环境部署前建议设置 NODE_ENV=production 环境变量