GrapesJS 快速入门:3 条命令跑起拖拽式 Web 可视化编辑器
【免费下载链接】grapesjsFree and Open source Web Builder Framework. Next generation tool for building templates without coding项目地址: https://gitcode.com/GitHub_Trending/gr/grapesjs
GrapesJS 是一个免费开源的 Web 可视化编辑器框架,靠拖拽就能产出可用的 HTML 模板,全程不写代码。读完本文,你能把源码拉到本地、通过环境校验、启动开发服务器,并确认编辑器界面正常可用。
先看成品:编辑器长什么样
这是编辑器启动后的默认样子:中间大片白色区域是可编辑画布,左侧竖排的工具图标对应图层、页面、区块等面板,右侧是属性栏,尺寸、边距、字体等都在这里调。浏览器里看到的效果和这张图一致——画布可选中、面板能展开、属性能修改——就可以算跑通了。
环境体检:一条命令核对三件套
🧰 开工前备齐三个工具,版本有明确建议:
| 工具 | 建议版本 | 用途 |
|---|---|---|
| Node.js | 20 LTS | JS 工程的运行时 |
| pnpm | 9.10 及以上 | 装依赖的包管理器,作用类似 npm |
| Git | 任意近期版本 | 拉取源码 |
一行命令把三处一次性验完:
node -v && pnpm -v && git --version执行后会依次打印三个版本号,看到v20.x.x、9.10.0、git version 2.x之类的输出即可开工。哪一行报错了,就先补装哪个,别硬往下走。
最快拿到源码的两种方式
推荐直接克隆,仓库地址固定如下:
git clone https://gitcode.com/GitHub_Trending/gr/grapesjs cd grapesjs克隆完成会得到grapesjs目录,后续命令都在这个根目录里执行。
不方便用 Git 时,可以到仓库页面下载源码压缩包,解压后同样是grapesjs目录,后面步骤完全一致。
仓库是 monorepo 结构,代码分散在几个子包:编辑器本体的源码在packages/core/,另有构建工具packages/cli/和文档docs/,改代码时先认准这个位置。
三步启动并自测
第 1 步:装依赖
pnpm install按 lockfile 给所有子包装齐依赖,首次执行会慢一些,耐心等。终端末尾没有报错、node_modules目录生成,这步算过。
第 2 步:起开发服务
pnpm start在 core 子包内拉起 webpack 开发服务器,之后改源码,浏览器里能实时看到变化。
第 3 步:浏览器验收
打开http://localhost:8080/,对照第一张图看三个验收点:中间画布加载出来、左侧面板图标齐全、右侧属性栏正常渲染。三处都在,就算成功。
🏷️ 需要生产构建时补一条,各子包下会生成dist目录存放发布产物:
pnpm run build日常高频命令一览表
| 命令 | 作用 |
|---|---|
pnpm start | 起开发服务器,到 localhost:8080 调试 |
pnpm run build | 打生产版本,产出 dist 文件 |
pnpm test | 跑全部子包的测试用例 |
pnpm lint | ESLint 检查代码风格 |
pnpm format | Prettier 一键格式化所有文件 |
新手常见卡点
- 首次安装特别慢:monorepo 依赖量大,第一条
pnpm install跑几分钟属正常现象,别中途 Ctrl+C;卡死不动再考虑换网络重试。 - 8080 端口被占用:
pnpm start后浏览器打不开、终端提示端口冲突时,找出占用 8080 的进程停掉再重启即可。 - 版本不达标:仓库声明了
node >= 20、pnpm >= 9,体检输出低于这个线的,先升级再继续,否则安装阶段容易报错。
接下来去哪儿
- 想贡献代码:先读 CONTRIBUTING.md,里面写清了环境搭建和提交流程
- 想看各模块用法:查官方文档目录 docs/,api、guides、modules 三类都有
- 想直接改编辑器:入口是核心源码 packages/core/src/
【免费下载链接】grapesjsFree and Open source Web Builder Framework. Next generation tool for building templates without coding项目地址: https://gitcode.com/GitHub_Trending/gr/grapesjs
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考