# vite-auto-deploy

**Repository Path**: mxp_open/vite-auto-deploy

## Basic Information

- **Project Name**: vite-auto-deploy
- **Description**: vite-auto-deploy 自动打包并上传打包后的文件到服务器指定目录的插件的js代码
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2022-11-12
- **Last Updated**: 2025-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 介绍

用于自动打包并上传打包后的文件到服务器指定目录的项目，此插件需要配合服务器端代码才能实现。(详见:[服务器开发指南](#服务器开发指南)))，具体功能如下：

1. 客户端运行 `vite build`后自动压缩并上传打包好的文件至指定服务器的指定目录中
2. 服务器解压传过来的源代码->删除已存在的指定目录的所有内容->保存解压后的文件到指定目录中
3. 使用 js 编写且源码简单注释详细易于修改，可自行修改与扩展
4. 注意：服务器会验证设备 mac 是否在允许上传的设备白名单内，且服务器必须配置允许上传的`{'项目名':'保存目录'}`的键值对白名单

## 安装

```js

npm i vite-auto-deploy
// 或
pnpm i vite-auto-deploy
// 或
yarn add vite-auto-deploy

```

## 使用

```js
//在 vite.config.js文件中添加
import autoDeploy from 'vite-auto-deploy';
import { defineConfig } from 'vite';
export default defineConfig(() => {
  return {
    plugins: [
      autoDeploy({
        projectKey: '', // 项目名称 用于服务器端获取保存到哪一个目录下 【也可用于限制那些项目可以上传，只有在允许项目的白名单内才可以上传】
        uploadUrl: '', // 上传地址 如：https://www.xxxxx.com/auto_deploy/main/deploy.php
        saveLocalZip: false, // 是否保存本地zip文件 默认false
      }),
    ],
  };
});
```