# 文件快传助手

**Repository Path**: codewithlong/file-quick-transfer-assistant

## Basic Information

- **Project Name**: 文件快传助手
- **Description**: 一个简单易用的局域网文件传输工具，支持跨设备文件上传、下载和管理，适配桌面和移动端浏览器访问。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-05-30
- **Last Updated**: 2026-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 局域网文件传输(适配win系统)

一个简单易用的局域网文件上传下载工具，支持桌面和移动端浏览器访问。

## 功能特点

- 跨平台访问：浏览器即可访问，桌面移动端自适应
- 文件夹管理：创建、浏览文件夹
- 文件上传：拖拽或点击上传，支持大文件
- 文件下载：点击下载，文件名中文自动处理
- 文件删除：支持单文件和批量删除
- 安全防护：文件类型白名单、大小限制、路径隔离
- 简洁界面：现代化设计，操作直观

## 技术栈

**后端**：Python 3.9+ / FastAPI / Uvicorn / tkinter

**前端**：Vue 3 / Element Plus / Vite / Axios

## 项目结构

```
file_server/
├── backend/              # 后端服务
│   ├── main.py          # FastAPI 主程序
│   ├── server_gui.py    # 桌面 GUI
│   ├── config.py        # 配置文件
│   ├── utils.py         # 工具函数
│   └── run_server.py    # 启动入口
└── frontend/            # 前端应用
    ├── src/
    │   ├── components/  # Vue 组件
    │   ├── api/        # API 接口
    │   └── App.vue     # 根组件
    └── index.html
```

## 快速开始

### 环境要求

- Python 3.9+
- Node.js 18+

### 后端运行

```bash
cd backend
pip install -r requirements.txt
python run_server.py
```

启动后会自动打开配置窗口，选择文件夹后点击启动。

### 前端开发

```bash
cd frontend
npm install
npm run dev
```

### 构建前端

```bash
cd frontend
npm install
npm run build
```

构建产物在 `frontend/dist/`，可单独部署。

## 使用方法

1. 运行 `backend/run_server.py` 打开配置窗口
2. 点击「选择文件夹」选择要共享的文件夹
3. 可选：点击「文件类型配置」设置上传限制
4. 点击「启动」开启服务
5. 查看显示的访问地址，在浏览器中打开
6. 手机访问需在同一局域网下

![界面预览](./img/1.png)

### 手机端预览
![ui](./img/2.jpg)

### PC或平板端预览
![ui](./img/2.png)
![ui](./img/3.png)

## 主要接口

| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `/` | 前端页面 |
| GET | `/health` | 健康检查 |
| POST | `/upload` | 上传文件 |
| GET | `/download/{file_name}` | 下载文件 |
| GET | `/file_list` | 获取文件列表 |
| GET | `/folders` | 获取文件夹列表 |
| DELETE | `/file/{file_name}` | 删除文件 |

## License

MIT

## 联系方式

有问题或建议请联系：codewithlong@qq.com