How borntoberoot/networkmanager works
Main Components
• User Interface (Presentation Layer): Represented by the WPF application in the “Source/NETworkManager” directory that contains Views, XAML, and controls. Also include the custom controls in “Source/NETworkManager.Controls” and the resource (styles, templates) folders.
• MVVM Layer: The “ViewModels” folder components that act as the mediator between the UI and business logic. They implement the Model-View-ViewModel pattern and coordinate with Models.
• Business Logic & Domain Models: All the core functionality is implemented in separate libraries such as “NETworkManager.Models”, “NETworkManager.Profiles”, “NETworkManager.Settings”, “NETworkManager.Converters”, “NETworkManager.Validators”, etc. These are responsible for managing network data, configuration, profiles (encrypted sets of hosts/networks), and interaction with external devices and protocols.
• Utility & Infrastructure: Modules in “NETworkManager.Utilities” provide helper methods (for file operations, encryption, IP handling, etc.) and “NETworkManager.Update”, “NETworkManager.Setup” handle update distribution and installation.
• External Integrations & Services: Identify integrations with remote system connections (Remote Desktop, PuTTY, PowerShell, TigerVNC, AWS Session Manager) and the network analysis functions (IPScanner, Ping Monitor, port scanning, traceroute, DNS lookup, SNMP, etc.). Also include external API interactions (e.g., ip-api.com for geo-IP lookups and GitHub for update checks).
• Website & Documentation: The “Website” directory is a separate component using Docusaurus. It hosts documentation, changelogs, and releases. This can be represented as an independent subsystem that interfaces with the overall project for user documentation and web-based downloads.
• Build & CI/CD Infrastructure: Although not part of runtime, include your continuous integration (AppVeyor workflows, GitHub Actions, dependency management files, scripts for Chocolatey, WinGet, etc.) to illustrate deployment and packaging aspects.
Relationships and Data Flow
• That ViewModels invoke functionality from the Models (which encapsulate the business logic for network operations, profiles, and settings).
• That Models and Utility components provide the methods for network scanning, remote connections, and data conversion/validation.
• Installer and updater mechanisms (derived from Setup and Update projects) which pull artifacts from build scripts and CI workflows, and then (via package managers) distribute the signed binaries.
• Website component as a separate block that is linked to the project repository through documentation and release cycles.
Architectural Patterns and Design Principles
• Use of the MVVM pattern that separates Views, ViewModels, and Models.
• Modular structure where each major feature (e.g., remote connection, network scanning, settings management) is encapsulated in its own assembly or namespace.
• Dependency injection or service location if applicable (common in large WPF projects) among the various modules.
Relevant Technologies and Frameworks
• .NET 8.x and WPF as the primary development framework for the desktop application.
• Use of XAML for UI design, and tools like Visual Studio or Rider for development.
• Integration of third-party libraries/frameworks like Dragablz (for tearable tabs), log4net (logging), MahApps.Metro (UI toolkit), and various converters/validators.
• External packages (Chocolatey, WinGet) and build/CI tools (AppVeyor, GitHub Actions) which support the packaging and distribution.
• Drill down within each layer: for instance, show that the Presentation layer includes various dialogs, controls, and resource/style files, while the Business Logic layer contains sub-modules for network scanning, remote connectivity, settings and profiles.
• A separate section for the ancillary components (documentation/website, CI/CD, packaging artifacts).