:wave: 简介

这个应用是 Meshtastic 项目 的桌面客户端，旨在让用户能够可靠地管理大型分散的网状网络。目前，Meshtastic 客户端生态系统对单个节点的管理支持较强，但对网络级别的管理和分析支持较少。该项目的目标是通过新颖的算法分析和连接级洞察，让用户对其 Meshtastic 网络作为可靠的通信基础设施充满信心。

这个应用使用 Tauri 框架 构建，这是 Electron 框架 的现代、安全的继承者。这使我们能够在同一代码库中原生支持 Linux、macOS 和 Windows，而不会产生 Chromium 浏览器的性能或内存开销。我们的核心应用基础设施用 Rust 编写，因为它的性能和安全性，而我们的 UI 和客户端功能则用 React TypeScript 和 Vite 编写。这个项目目前处于早期开发阶段，因此尚不适合生产使用。

:pray: 寻求贡献

在撰写本文时，这个项目目前由一名开发者维护。因此，该项目正在寻找愿意为以下主要计划做出贡献或领导的开发者：

• 完整的离线地图支持，包括基于区域的下载和自定义地图加载（需要 Meshtastic 镜像 OSM 瓦片数据库）
• 跨客户端会话保持应用状态 （已完成）
• Rust 后端测试（单元、集成、端到端、冒烟测试）
• TS 前端测试（单元、集成、端到端、冒烟测试）
• 添加远程节点配置支持
• 将 UI 组件集成到 Storybook 框架中
• 在 UI 层添加 i18n 翻译支持 （已完成）
• 对应用文件结构进行总体重组，使项目更加直观

:rocket: 功能

这个项目仍处于早期开发阶段，但以下是我们正在开发的功能的粗略路线图。我们高度重视打造正确的核心基础设施，因为这是任何强大和有效的 UI 层的核心。

• :link: 核心数据流基础设施
  • 串行数据发送/接收
  • Rust protobuf 集成（.proto -> .rs）
  • 数据包编码/解码
  • 设备状态管理
• :art: 核心 UI 基础设施
  • Tauri 命令管理
  • Tauri 事件管理
  • Redux saga 数据流
• :artificial_satellite: 网络拓扑收集
  • 新数据包的 RFC（已完成）
  • MVP protobuf 更改（已完成）
  • MVP 固件更改（已完成）
  • 社区 protobuf 审查（已完成）
  • 社区固件审查（已完成）
• :nerd_face: 算法分析
  • 基础设施
    • 网络数据包整理
    • 网络图构建
    • 算法运行器
  • UI
    • MVP 算法运行器面板
    • 地图上的算法 UI
    • 自动重新运行算法
• :radio: 节点管理
  • 节点对等表
  • 网络配置（多设备）
  • 远程节点配置
• :pushpin: 路径点管理
  • 管理的路径点表
  • 频道内路径点发送
  • 地图上的路径点工具提示
• :globe_with_meridians: 网页客户端对等功能（UI）
  • 地图节点视图
  • 文本消息
  • 通过二维码导入/导出频道
  • 配置
    • 设备配置
    • 模块配置
    • 频道配置
• :mount_fuji: 离线地图视图
  • 离线地图存储
  • 基于区域的下载
• :page_facing_up: 网络数据导出

📻 硬件要求

这个项目建立在 Meshtastic 硬件生态系统之上，因此这个客户端需要您能够访问 Meshtastic 无线电。这可能在未来会改变，但目前需要物理无线电才能使用这个客户端。

我在这里写了一些个人硬件推荐。

:computer: 开发

先决条件

这个项目使用 Rust 和 React TypeScript 构建，并使用 PNPM 包管理器管理。因此，这个项目需要在您的开发机器上安装以下程序：

• Rust 语言
• Node.js
• PNPM 包管理器

安装

要在本地运行这个项目，请按照以下步骤操作：

1. 确保您已安装 Rust、Node.js 和 PNPM（参见先决条件）
2. 确保您已安装所有 Tauri 依赖项（取决于您的操作系统）
3. 将此仓库克隆到本地目录。可以通过运行 git clone https://github.com/meshtastic/network-management-client.git 来完成
4. 通过运行 git submodule update --init 递归克隆我们的 Git 子模块
5. 使用 pnpm i 安装所有必需的 NPM 包
6. 完成这些步骤后，使用 pnpm run rust:dev 命令验证您的安装。应用程序应该成功编译，您应该看到应用程序成功打开。如果这个过程对您失败，请告诉我们！

推荐的 IDE 设置

虽然这个项目可以在任何文本编辑器中开发，但我们推荐使用 Visual Studio Code 编辑器。如果使用 VSCode，我们强烈建议您安装以下 Visual Studio Code 扩展。这些扩展既强制执行代码风格，又为我们的技术栈提供语言和框架支持。

• Prettier - 我们 UI 代码的格式化工具
• ESLint - 我们 UI 代码的静态代码分析工具
• rust-analyzer - Rust LSP，具有代码检查、格式化和质量建议功能

一些可选的扩展，虽然不是必需的，但我们发现非常有用：

• Tauri - 添加Tauri 命令代码片段和配置JSON验证
• GitLens - 一个用于处理Git历史的有用插件

开发命令

为了规范我们的开发流程，我们使用PNPM命令，这些命令定义在package.json中。这些命令可以通过pnpm run 名称 ...参数的语法运行。我们的命令主要分为两类：rust:*命令和ui:*命令。rust:*命令运行整个桌面应用程序，而ui:*命令只运行UI层。

注意：我们强烈建议不要手动使用ui:dev和ui:build命令。这些命令分别由rust:dev和rust:build命令内部调用。运行ui:dev命令时，您将无法连接到串行设备，因为这个逻辑不在UI层处理。

我们目前正在添加对Storybook框架的支持，这将允许贡献者在不运行整个桌面应用程序的情况下开发UI组件。

• pnpm run rust:dev - 以开发模式启动桌面应用程序，允许UI和Rust代码的热重载

• pnpm run rust:build - 以生产模式为您的系统架构构建桌面应用程序。目前我们只使用这个命令来测试我们应用程序的CLI参数解析器。

• pnpm run rust:test - 在Rust代码库目录（/src-tauri）上运行后端测试。这个命令还会在/src-tauri/bindings目录中生成TypeScript客户端绑定。添加-- --show-output可以显示测试套件中的Rust println!宏调用。

• pnpm run ui:dev - 启动UI开发服务器，允许在浏览器环境中进行UI开发。注意，任何与Rust后端交互的代码在这个浏览器环境中都无法运行，这意味着在这种情况下您将无法连接到串行设备

• pnpm run ui:build - 在dist目录中对UI代码进行生产构建

• pnpm run ui:lint - 使用ESLint检查代码风格错误。注意，我们的CI管道要求这个命令成功执行，才能合并任何更改

• pnpm run ui:format - 使用Prettier和ESLint格式化UI代码库。我们强烈建议您在创建PR之前运行这个命令！

• pnpm run ui:test - 使用Jest运行UI测试套件。目前项目还没有UI测试套件，但我们非常欢迎贡献！

• pnpm run ui:preview - 从dist目录运行构建好的UI。这个命令必须在ui:build之后运行 (已弃用)

**注意：**在Linux上，您的用户可能没有权限访问给定的串行端口。如果发生这种情况，您可能需要将您的用户添加到控制您想要访问的串行端口的组中。您可以通过ls -ld 端口路径命令找到控制串行端口的组。您可以通过usermod -a -G 组名 $USER命令将您的用户添加到这个组中。

:heart: 贡献

由于我们仍处于开发的早期阶段，我们还没有标准化的框架来接受贡献。话虽如此，我们非常欢迎建议和/或代码更改！如果您有兴趣为这个仓库做出贡献，我们希望您首先查看我们的问题板，以确保您的工作不会重复他人的工作。然后，请在我们的板上创建一个问题，让我们知道您有兴趣做什么。如果您对项目有任何疑问，我们很乐意听取您的意见！