PairDrop 安装与使用教程

PairDrop 是一个灵感源于苹果AirDrop的开源项目，它提供了一个无需设置和注册即可跨平台分享文件的浏览器应用。本教程将指导你了解其目录结构、启动文件和配置文件。

1. 项目目录结构及介绍

在下载或克隆 PairDrop 仓库后，你将看到以下基本的目录结构：

PairDrop/
├── dist/                # 存放编译后的前端资源
├── src/                 # 源代码目录
│   ├── client/          # 前端客户端代码
│   │   ├── css/         # 样式文件
│   │   ├── js/          # JavaScript 文件
│   │   └── index.html    # 主页模板
│   └── server/          # 后端服务器代码
│       ├── config.js     # 配置文件
│       ├── index.js      # 启动文件
└── package.json         # 项目依赖及构建脚本

• dist/ 目录包含通过构建过程生成的用于部署的前端资源。
• src/client/ 包含所有前端界面的HTML、CSS和JavaScript代码。
• src/server/ 包含Node.js服务器端代码，负责处理WebRTC和其他网络通信。
• config.js 是服务器端的配置文件，可以定制STUN/TURN服务器等设置。
• package.json 列出了项目依赖和npm脚本，用于安装依赖和执行构建任务。

2. 项目的启动文件介绍

• src/server/index.js: 这是后端服务器的入口文件。当你运行项目时，这个文件会被执行以启动Web服务。它包含了启动WebRTC服务器、监听HTTP请求以及处理文件传输的相关逻辑。

要启动 PairDrop 服务，确保你已全局安装了 node 和 npm，然后在项目根目录中运行：

$ npm install
$ npm start

这将在指定的端口上启动服务，你可以根据 config.js 中的配置进行调整。

3. 项目的配置文件介绍

• src/server/config.js: 这个文件是用来配置 PairDrop 的各种参数，如服务器监听的端口、使用的STUN/TURN服务器等。

示例配置：

module.exports = {
  port: 3000,
  stunServers: [
    { url: 'stun:stun.l.google.com:19302' },
    // 添加更多STUN服务器...
  ],
  turnServers: [
    {
      url: 'turn:numb.viagenie.ca',
      username: '<YOUR_TURN_USERNAME>',
      credential: '<YOUR_TURN_PASSWORD>'
    }
  ]
};

• port：服务器监听的TCP端口，默认为3000，可以根据需求修改。
• stunServers：列出STUN服务器用于帮助WebRTC建立连接。
• turnServers（可选）：如果你的网络需要TURN服务器来穿透NAT，这里可以添加TURN服务器的详细信息。用户名和密码通常由你的服务器提供商提供。

记得根据实际情况更新配置文件中的细节，然后重启服务器以应用更改。

完成这些步骤后，你应该就能本地运行 PairDrop 并开始尝试跨设备文件共享了。如果遇到任何问题，查阅项目文档或GitHub上的Issue可能会有所帮助。祝你好运！