# zr-deploy

**Repository Path**: luoanb/zr-deploy

## Basic Information

- **Project Name**: zr-deploy
- **Description**: 前端项目自动化部署
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-01
- **Last Updated**: 2021-09-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# zr-deploy

[中文](./README_zh.md) | English

Web FrontEnd Spa, deploy script

> In fact, as long as it is an npm project (with package.json), it can generally be used

## Install

```shell
npm i -g zr-deploy
```

## Run

cd project directory

```shell
zr-deploy
```

## zr-deploy-config.json

- `local`

  - `buildCommand`: command in "scripts" in `package.json`
  - `distDir`: build output path
  - `distZip`: build output file/folder zip
  - `tipsLang`: opntional, value: `en` | `zh`; use `zh` when not provide

* `server`

  - `name`: name
  - `host`: server IP
  - `port`: server port
  - `username`: server login username
  - `password`: server login password
  - `distDir`: server preject path
  - `distZipName`: zip filename of upload
  - `bakeup`: bakeup or not

```json
[
  {
    "local": {
      "buildCommand": "yarn build",
      "distDir": "./docs",
      "distZip": "./docs.zip",
      "tipsLang": "en"
    },
    "server": {
      "name": "server1",
      "port": "22",
      "host": "1.1.1.1",
      "username": "username",
      "password": "password",
      "distDir": "/var/www/xxx/xxx",
      "distZipName": "dist",
      "bakeup": false
    }
  }
]
```

## Description

[Description.md](./Description.md)