Skip to content

DevEnvironmentSetup.md

Latest commit

 

History

History
60 lines (48 loc) · 1.78 KB

DevEnvironmentSetup.md

File metadata and controls

60 lines (48 loc) · 1.78 KB

Set up Development environment

Dev container

This repository contains a dev container which contains all the required SDKs to develop toolkit. See dev container website for more information how to run it.

Setting up the development environment

  • Check that you have latest .NET SDK 8 sdk version installed.
  • Clone the repository.
  • Run dotnet restore to restore the dependencies.
  • Run dotnet build to build the project.

Building, testing and packing projects

Toolkit solution

From the repository root directory:

  • Run dotnet build to build the project.
  • Run dotnet test to run the tests.
  • Run dotnet pack to pack the project. The package will be created in the output directory.

Set up the example solution

  • Open repository folder in terminal.
  • Run the script to set up example solution or check manual project build. 
    setup-example.cmd
  • Open examples folder in your IDE of choice (tested: Visual Studio, Visual Studio Code, Raider).

Manual example project build

  • Run command to build the project. 
    dotnet build
  • Run command to create NuGet package. Package will be created in output folder. 
    dotnet pack
  • Open examples folder in terminal.
  • Run command to build the example project. 
    dotnet build
  • Run command to test the example project. 
    dotnet test
  • Run command to restore compiler tool in the example project. 
    dotnet tool restore
  • Run command to compile policies in the example project. 
    dotnet azure-apim-policy-compiler --s .\source\ --o .\target\ --format true