快速开始
欢迎使用金恒科技信息化部前端团队工程体系!本指南将帮助你快速上手我们的前端工程化实践。
环境准备
闲话少叙,在开始之前,请确保你的开发环境满足以下要求:
必需工具
- Node.js: >= 18+ (推荐使用 LTS 版本)
- 包管理器: pnpm >= 10.16.1 (团队推荐)或 npm >= 9.0.0
推荐工具
- 编辑器: VS Code (团队标准编辑器)
- 终端:
git bash/cmder - Git:
>= 2.30.0 - 企业内部工具: 金恒科技内部开发工具集
安装依赖
安装 pnpm
如果你还没有安装 pnpm,可以通过以下命令安装:
bash
# 通过 npm 安装
npm install -g pnpm
# 或使用脚本安装(推荐)
curl -fsSL https://get.pnpm.io/install.sh | sh -验证安装
bash
node -v # 应该显示 v22.x.x 或更高版本
pnpm -v # 应该显示 10.x.x 或更高版本启动项目
进入项目目录并启动开发服务器:
bash
cd your-office-project
# 安装依赖
pnpm install
# 启动开发服务器
pnpm dev浏览器会自动打开 http://localhost:xxxx,你将看到项目首页。
👀 这里你要注意:
因为项目存在本地私有包的依赖,你需要根据开发环境配置 .npmrc 文件。
方式一:云桌面环境
如果你在云桌面环境中开发,在项目根目录创建 .npmrc 文件并添加以下配置:
bash
# 默认使用内网registry
registry=http://172.18.248.130/
# @jhlc scope 也使用内网registry
@jhlc:registry=http://172.18.248.130/
# pnpm配置
shamefully-hoist=true
strict-peer-dependencies=false
# 关闭严格的SSL检查(如果内网registry是http)
strict-ssl=false方式二:内网环境
如果你在内网环境中开发,在项目根目录创建 .npmrc 文件并添加以下配置:
bash
# pnpm配置
strict-peer-dependencies=false
auto-install-peers=true
shamefully-hoist=true
# —— 私有 scope & 私服配置 ——
@jhlc:registry=http://<内网registry地址>/
# —— 私服鉴权(写死 token) ——
always-auth=true
//<内网registry地址>/:_authToken=<你的token>
# —— 公共包依旧走官方源 ——
registry=https://registry.npmjs.org/个人设置方式
如果不想在项目中配置 .npmrc,也可以在个人目录(~/.npmrc)全局配置,或者使用命令行临时配置:
bash
# 设置 registry(替换为实际的内网地址)
npm config set registry http://<内网registry地址>/
# 安装依赖(使用 --force 或 --legacy-peer-deps)
pnpm install --force
# 或
pnpm install --legacy-peer-deps注意:一般项目会预配置
.npmrc,若没有在项目根目录请手动添加该文件。请根据实际开发环境选择对应的配置方式,并将<内网registry地址>和<你的token>替换为实际值。
常用命令
bash
# 开发
pnpm dev # 启动开发服务器
pnpm build # 构建生产版本
pnpm preview # 预览生产构建
# 其他命令维护完插件等依赖后补下一步
现在你已经成功创建并启动了项目,接下来可以:
遇到问题?
如果在使用过程中遇到问题:
- 查看 疑难杂症 寻找解决方案
- 在文档页面下方的评论区留言
- 联系团队成员获取帮助(企业微信/微信)
参与贡献
金恒科技信息化部前端团队欢迎任何形式的贡献:
- 🐛 报告 Bug(直接联系 409322)
- 💡 提出新功能建议(团队内部评审)
- 📝 改进文档(直接在评论区留言或提交 PR)
- 🔧 提交代码(遵循团队代码规范)
请查看 贡献指南 了解详细的贡献流程和规范。
提示
建议先阅读完整个指南版块,然后动手实践,这样能更快地掌握金恒科技信息化部前端团队的工程体系!如有疑问,请随时通过内部工号 409322取得联系或直接评论区留言。
