Skip to content

Latest commit

 

History

History
46 lines (39 loc) · 3.5 KB

setting_up_a_developer_machine.md

File metadata and controls

46 lines (39 loc) · 3.5 KB

Setting up a Developer Machine

Make sure you have the right prerequisites and meet the system requirements to develop applications that leverage the Var:ProductName public APIs.

Prerequisites

  • For the development environment, we recommend using var:VisualStudioEdition.
  • You need a licensed Var:ProductNameWithEdition or later installed on your development machine
  • We also recommend installation of the Var:ProductName SDK on your machine. Note that after the installation of Var:ProductName SDK, the New Project dialog box from var:VisualStudioEdition will feature additional project templates specific to the Var:ProductName application development.
    • You can get the latest version from the developer hub.
    • Or you can install directly from var:VisualStudioEdition -> Tools -> Extensions
  • If your implementations need to connect to a TM Server system, then make sure that the TM Server also runs the latest version.
  • If you are developing against a version of API the which is distributed with one of SDL's publicly released applications (i.e. Var:ProductNameWithEdition), then all required assemblies and files should be available alongside the application. Make sure that you have the latest release of Var:ProductName installed.

Note

As build output path for your implementations please choose the var:PluginPackedPath

Also check that your library references are pointing to the Var:ProductName folder. e.g. var:InstallationFolder.

For more informations regarding how to build and deploy a Studio plug-in see Building a plug-in and Plug-in deployment

Sign and use Strong-Named Assemblies to enable the loading of your plug-ins inside Var:ProductName. For more information see How to: Sign an Assembly with a Strong Name
If you don't have a key, you can download SdlCommunity.snk key from public AppStore repository.

Choosing a different build output path or not signing your assembly will prevent your plugin to be loaded.

System requirements for running Var:ProductNameWithEdition:

  • A Microsoft Windows-based PC or an Intel-based Apple Mac computer running Windows as an operating system. Var:ProductNameWithEdition runs on the latest build of Windows 10 and the latest updated version of Windows 8.1.
  • Up to 2.5 GB of available disk space to run the Var:ProductNameWithEdition installer
  • 2 GB of available disk space to run Var:ProductNameWithEdition
  • A recent processor with dual or multi-core technology
  • At least 8 GB RAM
  • Var:ProductNameWithEdition requires Microsoft .Net Framework 4.8.
  • Additional details can be found on the product release notes

System requirements for running SDL GroupShare (SDL TM Server, SDL Multiterm, SDL Project Server):

  • Windows Server 2019, with IIS 10 / Windows Server 2016, with IIS 10 / Windows Server 2012 R2, with IIS 8.5
  • The database servers supported are: SQL Server 2019 / SQL Server 2017 / SQL Server 2016
  • Additional details can be found on the product release notes