network management client

重要的

？網絡網絡管理客戶客戶端需要一個新的平台所有者 /維護者嗎？

問題＃473可以提供更多詳細信息。

介紹

此應用程序是網格級項目的桌面客戶端，旨在允許用戶可靠地管理大型的，分散的網絡網絡。目前，網狀客戶端生態系統對管理單個節點有很大的支持，但對網絡級管理和分析的支持最少。該項目的目的是通過新穎的算法分析和連接級別的見解使用戶對其網絡網絡的信心作為可靠的通信基礎架構。

該應用程序是使用Tauri Framework建造的，Tauri框架是電子框架的現代安全繼任者。這使我們能夠在同一代碼庫中本地支持Linux，MacOS和Windows，而無需Chromium瀏覽器的性能或內存開銷。由於其性能和安全性，我們的核心應用程序基礎架構是生鏽書寫的，我們的UI和客戶功能使用VITE編寫。該項目處於開發的早期階段，因此尚不適合生產使用。

要求捐款

在撰寫本文時，該項目目前由單個開發人員維護。因此，該項目正在尋找願意為以下主要舉措做出貢獻或領導的開發人員：

• 完整的離線地圖支持，包括基於區域的下載和自定義地圖的加載（將需要OSM Tile DB的網格鏡像）
• 在客戶端會話中持續存在應用程序狀態（完全的）
• 生鏽的後端測試（單位，集成，E2E，煙）
• TS前端測試（單位，集成，E2E，煙）
• 添加對遠程節點配置的支持
• 將UI組件集成到故事書框架中
• 增加對UI層中I18N翻譯的支持（完全的）
• 應用程序文件結構的一般重組以使項目直觀

功能

該項目仍處於開發的早期階段，但這是我們正在努力的功能的粗略路線圖。我們將正確的核心基礎架構優先考慮，因為這是任何強大而有效的UI層的核心。

• ？核心數據流基礎架構
  • 序列數據發送/接收
  • Rust Protobuf集成（.proto-> .rs）
  • 數據包編碼/解碼
  • 設備狀態管理
• ？核心UI基礎架構
  • 陶裡命令管理
  • 陶裡事件管理
  • Redux Saga數據流
• ？網絡拓撲系列
  • RFC用於新穎包（已完成）
  • MVP Protobuf更改（完成）
  • MVP固件更改（完成）
  • 社區Protobuf評論（完成）
  • 社區固件評論（完成）
• ？算法分析
  • 基礎設施
    • 網絡數據包整理
    • 網絡圖構造
    • 算法跑步者
  • UI
    • MVP算法Runner Pane
    • 在地圖算法UI
    • 自動算法重新設計
• ？節點管理
  • 節點對等表
  • 網絡配置（多設備）
  • 遠程節點配置
• ？航點管理
  • 託管航路點表
  • 渠道內路點發送
  • 在地圖Waypoint工具提示
• Web客戶端均等（UI）
  • 地圖節點視圖
  • 文本消息傳遞
  • 通過QR碼導入/導出頻道
  • 配置
    • 設備配置
    • 模塊配置
    • 頻道配置
• ？離線地圖視圖
  • 離線地圖存儲
  • 基於區域的下載
• ？網絡數據導出

？硬件要求

該項目建立在網狀硬件生態系統上，因此該客戶端要求您可以訪問網格廣播。這可能在將來發生變化，但是暫時需要一個物理收音機才能使用此客戶端。

我在這裡寫了一些個人硬件建議。

發展

先決條件

該項目是用Rust和React打字稿內置的，並使用PNPM軟件包管理器進行管理。因此，該項目需要在開發機上安裝以下程序：

• 生鏽語言
• 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 subsodules
5. 使用pnpm i安裝所有必需的NPM軟件包
6. 完成這些步驟後，請使用pnpm run rust:dev Command驗證安裝。該應用程序應成功編譯，您應該成功地看到應用程序打開。如果此過程失敗了，請告訴我們！

推薦的IDE設置

儘管可以在任何文本編輯器中開發此項目，但我們建議Visual Studio代碼編輯器。如果使用VSCODE，我們強烈建議您安裝以下Visual Studio代碼擴展。這些擴展既強制執行代碼樣式，又可以為我們的技術堆棧提供語言和框架支持。

• Prettier-我們的UI代碼的格式化器
• ESLINT-我們的UI代碼的Linter
• 生鏽分析儀 - 帶代碼覆蓋，格式和高質量建議的Rust LSP

一些不需要的可選擴展名，但我們發現很有幫助：

• Tauri-添加Tauri命令片段和配置JSON驗證
• Gitlens-一個有用的插件，用於使用GIT歷史

開發命令

為了標準化我們的開發流程，我們使用package.json中定義的PNPM命令。這些命令可以使用pnpm run NAME ...ARGS語法運行。我們的命令分為兩個主要類別： rust:*命令和ui:*命令。 rust:*命令運行整個桌面應用程序，其中ui:*命令僅運行UI層。

注意：我們強烈建議您不使用ui:dev和ui:build命令。這些命令在內部由rust:dev和rust:build命令。運行ui:dev命令時，您將無法連接到串行DEVCE，因為該邏輯未在UI層中處理。

我們目前正在努力增加對Storybook框架的支持，該框架將允許貢獻者開發UI組件，而無需運行整個桌面應用程序。

• pnpm run rust:dev在開發模式下啟動桌面應用程序，可以熱加載UI和Rust Code

• pnpm run rust:build - 在系統體系結構的生產模式下構建桌面應用程序。目前，我們僅使用此命令來測試應用程序的CLI參數解析器。

• pnpm run rust:test - 在Rust Codebase目錄（ /src-tauri ）上運行後端測試。此命令還會在/src-tauri/bindings目錄中生成TypeScript客戶端綁定。添加-- --show-output顯示Rust println!測試套件中的宏通話。

• pnpm run ui:dev啟動UI開發服務器，允許在瀏覽器環境中開發UI。請注意，任何與Rust後端連接的代碼都不會在此瀏覽器環境中起作用，這意味著您將無法在此上下文中連接到串行設備

• pnpm run ui:build ： - 在UI代碼上運行生產構建到dist目錄

• 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 PATH_TO_PORT_HERE命令找到控制串行端口的組。您可以通過usermod -a -G GROUP_NAME_HERE $USER命令將用戶添加到此組中。

❤️貢獻

由於我們還在很早的開發中，因此我們還沒有接受貢獻的標準化框架。話雖如此，我們對建議和/或代碼更改非常開放！如果您有興趣為此存儲庫做出貢獻，我們會要求您首先檢查我們的發行委員會，以確保您的工作不會重複他人的工作。然後，請在我們的董事會上提出問題，以便我們知道您有興趣的工作。如果您對該項目有任何疑問，我們很樂意收到您的來信！