# client

客户端，vue3

---

## node.js 的版本需要  16.20.1

```shell

// 检查你的node版本, 如果低于 16.20.1, 请先更新node.js

node -v

```

---

### 推荐使用  `yarn` 管理依赖

如果电脑上还没有安装 `yarn` ，执行以下命令安装 `yarn`

``` shell
npm install -g yarn

//或者

cnpm install -g yarn
```

然后在 此项目下 执行

```shell
yarn

// 或者

yarn install
```

---

### `yarn` 的相关命令

安装依赖

```shell
yarn add 依赖名

// 或者
yarn add -D 依赖名
```

检测依赖更新

```shell
yarn upgrade-interactive --latest
```

js-fast-way 文档

- **[文档地址](https://js-fast-way.vercel.app/)**
- **[国内文档地址](http://izaizaiaa.gitee.io/js-fast-way)**

---

### 打包说明

`build:all` 为一键打包为zip的方式，会打包出来两个文件，一个是常规的，一个是本地模式，本地模式通常用于第三方
`build:wgt` 为一键打包为zip的方式（不包含 `/public/plugins` 文件夹）

`server:xxx:all` 一键上传到服务器上并部署，其中，xxx，代表名字，对应 `/scripts/server.js` 里的配置，请保证已经编译打包过，并且zip文件存在，否则会出现异常
`server:xxx:wgt` 一键上传到服务器上并部署，跟上面一样，这个是不包含 `/public/plugins` 文件夹

如果要一键上传到服务器并解压，需要安装插件

MacOS上，需要安装 `sshpass`

```shell
#因特尔芯片

brew install hudochenkov/sshpass/sshpass

#m系列芯片

arch -arm64 brew install hudochenkov/sshpass/sshpass
```

Windows上，需要安装 [PuTTY](https://www.putty.org/), 并将其添加到系统 PATH 中

1.下载 PuTTY:
- 访问 PuTTY 官方网站: https://www.putty.org/
- 点击 "Download PuTTY" 按钮
- 选择适合你系统的安装包 (通常是 64-bit x86)

2.安装 PuTTY:
- 运行下载的安装文件
- 按照安装向导的提示进行安装
- 建议选择 "Full installation" 选项,确保安装所有组件

3.将 PuTTY 添加到系统 PATH:
- 右键点击 "此电脑" 或 "我的电脑",选择 "属性"
- 点击 "高级系统设置"
- 在 "系统属性" 窗口中,点击 "环境变量" 按钮
- 在 "系统变量" 部分,找到并选中 "Path" 变量,然后点击 "编辑"
- 点击 "新建",添加 PuTTY 的安装路径 (通常是 C:\Program Files\PuTTY)
- 点击 "确定" 保存所有更改

4.验证安装:
- 打开一个新的命令提示符窗口
- 输入 putty -version 并按回车
- 如果显示 PuTTY 的版本信息,说明安装成功并且已经添加到 PATH 中

5.确认 pscp 和 plink 可用:
- 在命令提示符中输入 pscp 并按回车
- 再输入 plink 并按回车
- 如果两个命令都能显示使用说明,说明它们已经可以使用了


### 其它说明

一般来说，`/public/plugins` 很少出现变动的情况。

在服务器上更新时，请注意，不要删除服务器上存在的 `plugins`，否则会出现异常。

如果本地 `/public/plugins` 文件夹 有变动，请使用 非 `wgt` 的打包方式

### 代码规范说明

项目启用了 `eslint` 作为代码规范检测

在 `vscode` 中，需要安装 `eslint` 插件，并且在 `settings.json` 中添加以下配置

```json
{
    "eslint.autoFixOnSave": true,
    "eslint.validate": [
        "javascript",
        "javascriptreact",
        {
            "language": "html",
            "autoFix": true
        },
        {
            "language": "vue",
            "autoFix": true
        }
    ],
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }
}
```

这时，在保存代码时，会自动格式化和处理掉一些不规范的代码，但这并不是准确的，保存后，请再检查下，是否有存在不合理的地方，进行手动优化。

在 `webstorm` 中，不需要安装插件，打开 webstorm 设置，语言和框架，`eslint`，勾选自动，再勾选保存时运行，即可。
