From 98233d7deb91b56f1e8d32dac21772a59eea8ce2 Mon Sep 17 00:00:00 2001 From: apefuu Date: Fri, 6 Sep 2024 12:01:30 +0800 Subject: [PATCH] Upgrade Docs --- docs/guide-zh-CN/code-curd-join.md | 2 +- docs/guide-zh-CN/code-curd.md | 2 +- docs/guide-zh-CN/code-tree.md | 2 +- docs/guide-zh-CN/start-deploy.md | 4 ++-- docs/guide-zh-CN/start-environment.md | 4 ++-- docs/guide-zh-CN/start-installation.md | 6 +++--- docs/guide-zh-CN/sys-code.md | 2 +- docs/guide-zh-CN/web-deploy.md | 10 +++++----- server/Makefile | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/guide-zh-CN/code-curd-join.md b/docs/guide-zh-CN/code-curd-join.md index 88fdf3d..a732158 100644 --- a/docs/guide-zh-CN/code-curd-join.md +++ b/docs/guide-zh-CN/code-curd-join.md @@ -10,7 +10,7 @@ gf run main.go # web端 cd web -yarn dev +pnpm run dev 或 npm run dev ``` 以下是一个关联表的CURD生成流程 diff --git a/docs/guide-zh-CN/code-curd.md b/docs/guide-zh-CN/code-curd.md index 0d89392..46a30bc 100644 --- a/docs/guide-zh-CN/code-curd.md +++ b/docs/guide-zh-CN/code-curd.md @@ -10,7 +10,7 @@ gf run main.go # web端 cd web -yarn dev +pnpm run dev 或 npm run dev ``` 以下是一个基本的CURD生成流程 diff --git a/docs/guide-zh-CN/code-tree.md b/docs/guide-zh-CN/code-tree.md index 8d7cc22..6583660 100644 --- a/docs/guide-zh-CN/code-tree.md +++ b/docs/guide-zh-CN/code-tree.md @@ -10,7 +10,7 @@ gf run main.go # web端 cd web -yarn dev +pnpm run dev 或 npm run dev ``` 以下是一个基本的树形CURD生成流程 diff --git a/docs/guide-zh-CN/start-deploy.md b/docs/guide-zh-CN/start-deploy.md index 7b57b12..d29afa6 100644 --- a/docs/guide-zh-CN/start-deploy.md +++ b/docs/guide-zh-CN/start-deploy.md @@ -41,7 +41,7 @@ cd server && make build cd server # 切换到服务端目录下 rm -rf ./resource/public/admin/ # 删除之前的web资源 mkdir ./resource/public/admin/ # 重新创建web资源存放目录，除首次编译后续可以跳过执行此步骤 -cd ../web && yarn build # 切换到web项目下，编译web项目 +cd ../web && pnpm run build # 切换到web项目下，编译web项目 \cp -rf ./dist/* ../server/resource/public/admin/ # 将编译好的web资源复制到server对应的资源存放路径下 cd ../server # 切换回服务端目录下 echo "y" | gf build # 编译hotgo服务端 @@ -58,7 +58,7 @@ echo "y" | gf build # 编译hotgo服务端 # 编译web端 cd web -yarn build +pnpm run build 或 npm run build # web端编译完成后，将web/dist/*中的文件上传到`server`端线上运行目录：/resource/public/admin即可 # 至此，web端和server端都可以独立覆盖更新 diff --git a/docs/guide-zh-CN/start-environment.md b/docs/guide-zh-CN/start-environment.md index 2741e17..dc90723 100644 --- a/docs/guide-zh-CN/start-environment.md +++ b/docs/guide-zh-CN/start-environment.md @@ -11,8 +11,8 @@ 1. 前往https://nodejs.org/zh-cn/下载当前版本node 2. 命令行运行 `node -v` 若控制台输出版本号则node安装成功 3. node 版本需大于等于 `16.0` -4. 安装yarn：`npm install -g yarn` -5. 命令行运行 `yarn -v` 若控制台输出版本号则前端环境搭建成功 +4. 安装pnpm：`npm install -g pnpm` +5. 命令行运行 `pnpm -v` 若控制台输出版本号则前端环境搭建成功 ### 后端环境 1. 下载golang安装 版本号需>=1.21 diff --git a/docs/guide-zh-CN/start-installation.md b/docs/guide-zh-CN/start-installation.md index 4c05b19..796abad 100644 --- a/docs/guide-zh-CN/start-installation.md +++ b/docs/guide-zh-CN/start-installation.md @@ -88,13 +88,13 @@ gfcli: 2、web前端： ```shell script cd web - # 首先确定你以安装node16.0以上版本并安装了包[npm、yarn]，否则可能会出现一些未知报错 + # 首先确定你以安装node16.0以上版本并安装了包[npm、pnpm]，否则可能会出现一些未知报错 # 安装依赖 - yarn install + pnpm install # 启动web项目 - yarn dev + pnpm run dev # 如果顺利，至此到浏览器打开：http://你的IP:8001/admin # 登录账号：admin, 密码：123456 diff --git a/docs/guide-zh-CN/sys-code.md b/docs/guide-zh-CN/sys-code.md index 63c69be..b829339 100644 --- a/docs/guide-zh-CN/sys-code.md +++ b/docs/guide-zh-CN/sys-code.md @@ -128,7 +128,7 @@ gfcli: ### 生成CRUD表格 - 推荐使用热编译方式启动HotGo，这样生成完成页面自动刷新即可看到新生成内容，无需手动重启 -- 服务端热编译启动：`gf run main.go`, web前端启动：`yarn dev` +- 服务端热编译启动：`gf run main.go`, web前端启动：`pnpm run dev` 或 `npm run dev` 1、创建数据表 diff --git a/docs/guide-zh-CN/web-deploy.md b/docs/guide-zh-CN/web-deploy.md index 427185f..51bc603 100644 --- a/docs/guide-zh-CN/web-deploy.md +++ b/docs/guide-zh-CN/web-deploy.md @@ -15,7 +15,7 @@ 项目开发完成之后，执行以下命令进行构建 ```shell -yarn build +pnpm run build 或 npm run build ``` 构建打包成功之后，会在根目录生成 dist 文件夹，里面就是构建打包好的文件 @@ -40,15 +40,15 @@ VITE_LEGACY = true 使用项目自定的命令进行预览(推荐) ```shell # 先打包在进行预览 -yarn preview +pnpm run preview 或 npm run preview # 直接预览本地 dist 文件目录 -yarn preview:dist +pnpm run preview:dist 或 npm run preview:dist ``` - 本地服务器预览(通过 live-server) ```shell # 1.全局安装live-server -yarn global add live-server +npm -g install live-server # 2. 进入打包的后目录 cd ./dist # 本地预览，默认端口8080 @@ -60,7 +60,7 @@ live-server --port 9000 ### 分析构建文件体积 如果你的构建文件很大，可以通过项目内置 [rollup-plugin-analyzer](https://github.com/doesdev/rollup-plugin-analyzer) 插件进行代码体积分析，从而优化你的代码。 ```shell -yarn report +pnpm run report 或 npm run report ``` 运行之后，在自动打开的页面可以看到具体的体积分布，以分析哪些依赖有问题。 diff --git a/server/Makefile b/server/Makefile index ad00cc0..9731f00 100644 --- a/server/Makefile +++ b/server/Makefile @@ -9,7 +9,7 @@ ADMIN_RESOURCE_PATH = "/resource/public/admin/" build: @rm -rf ./$(ADMIN_RESOURCE_PATH) @mkdir ./$(ADMIN_RESOURCE_PATH) - @cd ../web && yarn build && \cp -rf ./dist/* ../server$(ADMIN_RESOURCE_PATH) + @cd ../web && pnpm run build && \cp -rf ./dist/* ../server$(ADMIN_RESOURCE_PATH) @cd ../server @echo "y" | gf build @@ -37,7 +37,7 @@ auth: # 启动web服务 .PHONY: web web: - @cd ../web && yarn dev + @cd ../web && pnpm run dev # 刷新casbin权限 .PHONY: refresh