Required Tools - Synergex/HarmonyCore GitHub Wiki

Harmony Core Logo

Required Tools

For Harmony Core development, you will need the following components installed on a Windows development machine:

  • Visual Studio 2022 or later with at least the ".NET desktop development" and "ASP.NET and web development" workloads installed and all updates applied.

  • .NET SDK 8.0.

    • To determine which version of the .NET SDK is on your machine, enter the following at a Windows command prompt:

      dotnet --version

  • .NET Framework Runtime 4.7.2 or higher

  • Synergy/DE 11.1.1 or higher

    • Synergy/DE 32-bit and 64-bit
    • Synergy DBL Integration for Visual Studio
    • We recommend using the very latest version of all Synergy products at all times.

  • CodeGen

    • Always use the latest version of CodeGen for Harmony Core development.

    • See the CodeGen documentation for information on installing and updating CodeGen.

    • To determine which version of CodeGen is on your machine, enter the following at a Windows command prompt:

      codegen -checkversion

  • Harmony Core Solution Templates

    • Templates to help you get up and running quickly within a recommended pre-configured development environment.

    • Ensure you have the latest templates installed by running this command:

      dotnet new install Harmony.Core.ProjectTemplates

  • Harmony Core Solution Upgrade Tool

    • A command-line tool that upgrades projects created with earlier versions of Harmony Core.

      • Updates NuGet package references for Harmony Core and dependencies.
      • Updates CodeGen templates to match your Harmony Core version.
      • Updates your TraditionalBridge library code, if present.

    • To find out if you have the tool installed, use this command and look for harmony.core.clitool:

      dotnet tool list -g

    • If you don't have the tool installed, download and install it with this command:

      dotnet tool install -g Harmony.Core.CliTool

    • If you do have the tool installed, check for and install any updated version with this command:

      dotnet tool update -g Harmony.Core.CliTool

  • SSL Certificate

    • Harmony Core web services are exposed via the HTTPS protocol, so you will need an SSL certificate to install on your web server.
    • For development, .NET Core provides a way to create, install and trust a "self-signed certificate". You will be walked through configuring this when you read the SSL Certificate topic.

  • Internet access

    • Initially required to download NuGet packages.

Other Recommended Tools

The following tools are also recommended, but not required:

HTTP Testing Tools

  • Postman

    • A popular tool for developers to interact with and test HTTP-based services.
    • Available on Windows, Linux and MacOS.

  • Advanced REST Client

    • A multi-platform Postman alternative.

Browser JSON Formatting Tools

  • Google Chrome or Microsoft Edge
    • An extension that formats and color-codes JSON data viewed in Chrome

Next topic: Solution Templates