Skip to content

Commit

Permalink
修改README
Browse files Browse the repository at this point in the history
  • Loading branch information
fuchengwei committed Sep 19, 2020
1 parent 591d628 commit f8b6643
Showing 1 changed file with 52 additions and 27 deletions.
79 changes: 52 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,26 @@

前端一键自动化部署脚手架服务,支持开发、测试、生产多环境配置。配置好后一键即可自动完成部署。

# github
### github

[https://github.com/fuchengwei/deploy-cli-service](https://github.com/fuchengwei/deploy-cli-service)

# npm
### npm

[https://www.npmjs.com/package/deploy-cli-service](https://www.npmjs.com/package/deploy-cli-service)

# 安装
#### 更新日志

全局安装 deploy-cli-service
[https://github.com/fuchengwei/deploy-cli-service/wiki/更新日志](https://github.com/fuchengwei/deploy-cli-service/wiki/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97)

```shell
npm install deploy-cli-service -g
```
## 1 安装

查看版本,表示安装成功
全局安装 deploy-cli-service

```shell
deploy-cli-service -v
npm install deploy-cli-service -g
```

<img src="https://s1.ax1x.com/2020/09/14/wBTOGd.png" alt="wBTOGd.png" style="zoom:40%;" align='left' />

本地安装 deploy-cli-service

```shell
Expand All @@ -34,39 +30,53 @@ npm install deploy-cli-service --save-dev

查看版本,表示安装成功

```javascript
deploy-cli-service -v
```

注:本地安装的需要在调用前加 `npx`

```shell
npx deploy-cli-service -v
```

<img src="https://s1.ax1x.com/2020/09/14/wBLF00.png" alt="wBLF00.png" style="zoom:40%;" align='left' />
![](https://s1.ax1x.com/2020/09/19/wIK8PK.png)


# 使用(以下代码都以全局安装为例)

#### 1.查看帮助
### 2 使用(以下代码都以全局安装为例)

#### 2.1 查看帮助

```shell
deploy-cli-service -h
```

<img src="https://s1.ax1x.com/2020/09/14/wBL0Bt.png" alt="wBL0Bt.png" style="zoom:100%;" align='left' />
![](https://s1.ax1x.com/2020/09/19/wIKrPf.png)


#### 2.初始化配置文件(在项目目录下)

#### 2.2 初始化配置文件(在项目目录下)

```shell
deploy-cli-service init # 或者使用简写 deploy-cli-service i
```

根据提示填写内容,会在项目根目录下生成 `deploy.config.js` 文件,初始化配置只会生成 `dev` (开发环境)、`test` (测试环境)、`prod` (生产环境) 三个配置,再有其他配置可参考模板自行配置。

<img src="https://s1.ax1x.com/2020/09/14/wBOXRg.png" alt="wBOXRg.png" style="zoom:100%;" align='left' />
![](https://s1.ax1x.com/2020/09/19/wIMRSO.png)



#### 3.手动创建或修改配置文件
#### 2.3 手动创建或修改配置文件

在项目根目录下手动创建 `deploy.config.js` 文件,复制以下代码按情况修改即可。

```javascript
module.exports = {
projectName: 'vue_samples', // 项目名称
privateKey: '/Users/fuchengwei/.ssh/id_rsa',
passphrase: '',
dev: {
// 环境对象
name: '开发环境', // 环境名称
Expand All @@ -76,7 +86,8 @@ module.exports = {
username: 'root', // 服务器登录用户名
password: '123456', // 服务器登录密码
distPath: 'dist', // 本地打包生成目录
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
isRemoveRemoteFile: true // 是否删除远程文件(默认true)
},
test: {
// 环境对象
Expand All @@ -87,7 +98,8 @@ module.exports = {
username: 'root', // 服务器登录用户名
password: '123456', // 服务器登录密码
distPath: 'dist', // 本地打包生成目录
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
isRemoveRemoteFile: true // 是否删除远程文件(默认true)
},
prod: {
// 环境对象
Expand All @@ -98,12 +110,13 @@ module.exports = {
username: 'root', // 服务器登录用户名
password: '123456', // 服务器登录密码
distPath: 'dist', // 本地打包生成目录
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
},
webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
isRemoveRemoteFile: true // 是否删除远程文件(默认true)
}
}
```

#### 4.部署 (在项目目录下)
#### 2.4 部署 (在项目目录下)

注意:命令后面需要加 `--mode` 环境对象 (如:`--mode dev`

Expand All @@ -113,18 +126,30 @@ deploy-cli-service deploy --mode dev # 或者使用 deploy-cli-service d --mode

输入 `Y` 确认后即可开始自动部署,看见如下提示说明部署完成

<img src="https://s1.ax1x.com/2020/09/14/wBzk7R.png" alt="wBzk7R.png" style="zoom:100%;" align='left' />
![](https://s1.ax1x.com/2020/09/19/wIQLU1.png)



#### 5.本地安装扩展
#### 2.5 本地安装扩展

如果使用本地安装命令的话,可以在项目根目录下的 `package.json` 文件中 `scripts` 脚本中添加如下代码

<img src="https://s1.ax1x.com/2020/09/14/wBzLvD.png" alt="wBzLvD.png" style="zoom:50%;" align='left' />
```json
"scripts": {
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint",
"deploy:dev": "deploy-cli-service deploy --mode dev",
"deploy:test": "deploy-cli-service deploy --mode test",
"deploy:prod": "deploy-cli-service deploy --mode prod"
}
```

然后使用下面代码也可以完成部署操作

```shell
npm run deploy:dev
```

最后谢谢大家支持,欢迎 Star 😜😜😜。
最后如果大家觉得还不错挺好用的话,麻烦给个 Star 😜😜😜。

0 comments on commit f8b6643

Please sign in to comment.