&label=version){kind=icon}
Before building the app, make sure your system meets the following requirements:
- Operating System: Windows 10 version 1903 or higher.
- Development Tools:
- Visual Studio (latest version recommended).
- Workload:
.NET Multi-platform App UI Development (MAUI). - Optional but helpful: ASP.NET and web development workload for Blazor support.
- Dependencies:
- Install the .NET 8 (or later) SDK.
- Add the
Windows App SDKextension during Visual Studio installation.
- Git: Install Git for version control if not already installed.
- Open a terminal (Command Prompt, PowerShell, or Git Bash).
- Run the following command to clone the repository:
git clone https://github.com/Llama-Logic/PlumbBuddy.git cd PlumbBuddy
- Open the PlumbBuddy.sln file in Visual Studio.
- Set the Startup Project:
- Right-click the project named
PlumbBuddyand select Set as Startup Project.
- Right-click the project named
- Select the Windows Machine target:
- Use the dropdown menu in the Visual Studio toolbar to choose the
Windowsplatform.
- Use the dropdown menu in the Visual Studio toolbar to choose the
- Restore dependencies:
- Open the Package Manager Console (or terminal) and run:
dotnet restore
- Open the Package Manager Console (or terminal) and run:
- Build the project:
- Press
Ctrl + Shift + Bor select Build > Build Solution from the menu.
- Press
- To run the app:
- Press
F5to start the app in Debug mode. - Or press Ctrl + F5 to run the app without debugging.
- Press
- The app should launch in a Windows desktop window.
- Ensure all required workloads (MAUI, ASP.NET) and SDKs are installed.
- Double-check that you've restored NuGet packages using
dotnet restore. - If you encounter issues with Windows App SDK, try repairing the Visual Studio installation and ensuring the Windows App SDK is up to date.
- Confirm that the Resources folder contains the app icon and splash screen in the correct formats
Ensure your system meets the following requirements:
- Operating System: macOS 14 (Sonoma) or higher.
- Development Tools:
- .NET 8 SDK: Download and install from the .NET website.
- Visual Studio Code: Install the latest version from the official site.
- .NET MAUI Extension for VS Code: Install from the VS Code Marketplace. This extension also installs the C# Dev Kit and C# extensions for debugging and building .NET projects.
- Apple Developer Tools:
- Xcode: Install the latest stable version via the Mac App Store.
- Command Line Tools for Xcode: Install by running
xcode-select --installin Terminal.
- Install .NET MAUI Workloads:
- Open Terminal and run:
This command ensures your system is ready to build and run MAUI projects.
dotnet workload install maui
- Open Terminal and run:
- Clone the Repository:
- In Terminal, execute:
git clone https://github.com/Llama-Logic/PlumbBuddy.git cd PlumbBuddy
- In Terminal, execute:
- Open the Project in VS Code:
- Launch Visual Studio Code.
- Open the cloned PlumbBuddy folder.
- Restore Dependencies:
- In VS Code's integrated terminal, run:
dotnet restore
- In VS Code's integrated terminal, run:
- Select Target Framework:
- In the VS Code status bar, click on the target framework selector (usually displays the current framework).
- Choose
.NET 8.0from the dropdown.
- Select Debug Target:
- Hover over the curly braces
{}in the status bar and select "Debug Target". - Choose
Mac Catalystto run the app as a native macOS application.
- Hover over the curly braces
- Build and Run the App:
- Press
F5to start debugging. - The app should launch as a macOS Catalyst app in a native macOS window.
- Press
- Missing Dependencies:
- Ensure all required workloads and SDKs are installed.
- Verify that Xcode is installed and up to date.
- Build Errors:
- Confirm that dependencies are restored using
dotnet restore.
- Confirm that dependencies are restored using
Click here to learn how to contribute.
PlumbBuddy relies on the following frameworks:
- Blazor
- Edge WebView2 (on Windows)
- .NET
- .NET Multi-platform App UI (MAUI)
- WebKit (on macOS)
PlumbBuddy uses the following libraries: