ZXManage 项目创建与导入功能使用文档

一、功能概述

ZXManage 支持新建项目和导入项目两种方式来管理你的前端/后端工程，可统一管理文件、代码、笔记并完成项目打包（该功能目前只支持vue、react、node项目）。、

图1：新建项目界面

图2：导入项目界面

二、新建项目（从零创建新项目）

1. 基础设置

进入「新建项目」标签页，完成以下必填配置：

配置项	说明	选项/输入要求
项目类型	选择项目技术栈模板	vue / react / uni-app / java / 微信小程序 / php / node / cocos / 文件 / 其他
项目名称	项目在 ZXManage 中的显示名称	支持中英文，示例：测试项目
所需功能	勾选需要启用的功能模块	✅ 文件管理 / 代码管理 / 笔记 / 项目打包（该功能目前只支持vue、react、node项目）
文件夹名称	项目在 ZXManage 代码目录的目录名	建议使用英文，避免代码运行异常
是否使用系统模板	是否使用 ZXManage 预设模板初始化	是 / 否（默认：否）
是否使用GIT	是否初始化 Git 仓库	是 / 否（默认：否）
GIT地址	Git 仓库地址	选择使用GIT时出现，初始化项目完成时需要推送的git仓库地址
分支名称	Git 仓库分支	选择使用GIT时出现，初始化项目完成时需要推送的git仓库分支
ICON	项目图标（可选）	点击「上传ICON」区域，选择本地图片作为项目图标

2. 高级选项说明

• 系统模板：若选择「是」，将基于所选项目类型（如 Vue）自动生成基础项目结构（包含路由、状态管理等预设配置），适合快速启动标准项目。
• Git 初始化：若选择「是」，将自动在项目目录执行 git init，并根据填写的仓库地址及分支自动推送初始化目录至远程仓库。

⚠️ 警告：选择使用GIT功能和模板功能需提前配置好 Git 环境与凭证，否则会操作失败。

三、导入项目（从本地或 Git 导入已有项目）

1. 入口与基础设置

进入「导入项目」标签页，完成以下必填配置：

配置项	说明	选项/输入要求
导入类型	选择项目来源	✅ 本地导入 / GIT导入
导入目录	选择本地项目根目录（仅本地导入时显示）	点击「选择目录」按钮，选择项目所在文件夹
GIT地址	需要导入的GIT源地址（仅GIT导入时显示）	输入GIT源地址
项目类型	标记项目技术栈	vue / react / uni-app / java / 微信小程序 / php / node / cocos / 文件 / 其他
项目名称	项目在 ZXManage 中的显示名称	支持中英文，示例：测试项目
所需功能	勾选需要启用的功能模块	✅ 文件管理 / 代码管理 / 笔记 / 项目打包（该功能目前只支持vue、react、node项目）
文件夹名称	项目在 ZXManage 代码目录的目录名	建议使用英文，避免代码运行异常
ICON	项目图标（可选）	点击「上传ICON」区域，选择本地图片作为项目图标

⚠️ 警告：GIT导入功能需提前配置好 Git 环境与凭证，否则会拉取失败。

四、保存与后续操作

完成所有配置后，点击「保存」按钮：

• 导入项目：ZXManage 将扫描并加载所选目录的项目结构，进入项目管理页面。
• 新建项目：ZXManage 将在指定位置创建项目目录，并根据配置初始化项目文件与模板。

保存成功后，你可以在项目列表中找到该项目，进行文件管理、代码管理、笔记记录和打包等操作。

图2：功能主界面

五、常见问题与 Tips

💡 Tips：

1. 文件夹名称必须使用英文，否则可能导致代码编译、路径解析失败。
2. 导入项目时，若目录过大，加载可能需要几分钟时间，请耐心等待。
3. 项目 ICON 建议使用正方形图片（如 512×512px），以获得最佳显示效果。

⚠️ 警告：

• 请勿在 ZXManage 外部直接修改项目文件，否则可能导致 ZXManage 内的状态与实际文件不一致。
• 若启用 Git 功能，请确保本地已安装 Git 并配置好用户信息，否则无法正常提交代码。

六、完整配置示例

导入项目（本地 Vue 项目）

- 导入类型：本地导入
- 导入目录：/Users/xxx/Projects/my-vue-project
- 项目类型：vue
- 项目名称：我的Vue项目
- 所需功能：文件管理、代码管理、笔记、项目打包
- 文件夹名称：my-vue-project
- ICON：已上传（可选）

新建项目（无模板、无 Git 的 Node 项目）

- 项目类型：node
- 项目名称：我的Node服务
- 所需功能：文件管理、代码管理、笔记、项目打包
- 文件夹名称：my-node-service
- 是否使用系统模板：否
- 是否使用GIT：否
- ICON：未上传（可选）