# filego

**Repository Path**: Tab-Tan/filego

## Basic Information

- **Project Name**: filego
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-03
- **Last Updated**: 2026-02-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# FileGo - 局域网文件传输工具

FileGo 是一款基于 WebSocket 的文件传输工具，支持多平台使用（Web 浏览器和 Electron 桌面应用）。用户可以通过加入房间的方式，在同一网络内的设备之间快速传输文件。

## 功能特性

- **多端支持**：提供 Web 端和 Electron 桌面客户端
- **房间系统**：创建房间并分享 Room ID 即可加入传输
- **断点续传**：支持传输中断后继续传输，未完成文件可自动恢复
- **实时进度**：显示单个文件和总体传输进度
- **速度统计**：实时显示传输速度、剩余时间等统计信息
- **文件管理**：接收端可查看待接收文件列表并选择保存位置

## 项目结构

```
filego/
├── electron/           # Electron 桌面应用
│   ├── main.js        # 主进程代码
│   ├── preload.js     # 预加载脚本
│   └── renderer/      # 渲染进程界面
│       ├── index.html
│       └── receiver.js
├── server/            # WebSocket 服务器
│   └── src/
│       └── index.js
└── web/               # Web 端应用
    ├── src/
    │   ├── App.vue
    │   ├── main.js
    │   ├── components/
    │   │   ├── Receiver.vue
    │   │   ├── RoomJoin.vue
    │   │   └── Sender.vue
    │   ├── composables/
    │   │   ├── useReceiver.js
    │   │   ├── useSender.js
    │   │   └── useSocket.js
    │   └── styles/
    │       └── index.css
    └── vite.config.js
```

## 快速开始

### 环境要求

- Node.js 14+
- npm 或 yarn

### 安装依赖

分别进入各目录安装依赖：

```bash
# 安装服务端依赖
cd server
npm install

# 安装 Web 端依赖
cd web
npm install

# 安装 Electron 端依赖
cd electron
npm install
```

### 启动服务

```bash
# 启动 WebSocket 服务器
cd server
npm start

# 启动 Web 开发服务器
cd web
npm run dev

# 或构建 Web 生产版本
npm run build
```

### 使用 Electron 桌面端

```bash
cd electron
npm start
```

## 使用指南

### 创建房间

1. 打开应用
2. 输入房间名称和密码（如需要）
3. 点击创建房间按钮

### 加入房间

1. 输入对方提供的 Room ID
2. 输入房间密码（如有）
3. 点击加入房间

### 发送文件

1. 进入房间后将文件拖入或选择文件
2. 等待接收端确认保存位置
3. 传输自动开始

### 接收文件

1. 查看待接收文件列表
2. 选择保存位置
3. 确认接收后开始传输

## 技术实现

- **前端框架**：Vue.js 3
- **桌面应用**：Electron
- **通信协议**：WebSocket (Socket.io)
- **传输方式**：分块传输，支持断点续传
- **构建工具**：Vite

## 许可证

本项目遵循 MIT 许可证开源。