Environment Setup

Overview

This guide will explain how to configure the full system environment to make the Devon4Net.Template.WebAPI operate in Visual Studio Code.

Required software

Visual Studio Code

.Net Core SDK

C# Extension for VS Code

Setting up the environment

For Windows
Visual Studio Code

Download and install Visual Studio Code:

  1. Download the latest version here

    environment 1
    Figure 103. Download Page

  2. Open the downloaded installer, accept the terms and conditions, and then click next:

    environment 2
    Figure 104. License Agreement

  3. Select the location where Visual Studio Code will be installed. :

    environment 3
    Figure 105. Destination Folder

  4. Check the option if you do not wish to create a Start Menu folder, then click next:

    environment 4
    Figure 106. Start Menu Setup

  5. Check the boxes next to the options you wish to install for your environment, and then click next:

    Select the "Open with Code" options; this is a really useful tool, and if you don’t mark them, you won’t be able to configure them again unless you reinstall the application.
    environment 5
    Figure 107. Setup Additional Tasks

  6. Select next to begin the installation:

    environment 6
    Figure 108. Final Setup

  7. Select finish to end the installation and launch visual studio code:

    environment 7
    Figure 109. Completed Instalation
.Net Core SDK

Download and install .Net Core SDK:

  1. Download .Net SDK x64 for .Net 6.0

    environment 8
    Figure 110. Download Page .Net 6.0

  2. Open the downloaded installer, and click on the install button:

    environment 9
    Figure 111. Microsoft .NET SDK Installer

  3. Click in the close button to finish the installation:

    environment 10
    Figure 112. Microsoft .NET SDK Installer

  4. To verify the installation, open a command prompt and enter the following command:

    dotnet --version
    environment 11
    Figure 113. CMD dotnet command
OmniSharp extension

Download and install C# extension (by OmniSharp):

  1. Open Visual Studio, go to the extensions section (1), search for C# extensions (2) and install the C# extension by OmniSharp:

    environment 12
    Figure 114. Extensions Site in Visual Code Studio
For Linux Systems

This guide is intended for Ubuntu/Debian distributions; if you are using another Linux distribution, please refer to the official Visual Code Studio documentation

Visual Studio Code

Download and install Visual Studio Code:

  1. Download the latest version here

    environment 15
    Figure 115. Download Page

  2. To install, open a terminal within the Downloads folder (or the location where the binary was downloaded) and run the following command:

    sudo apt install ./<file>.deb

# If you're on an older Linux distribution, you will need to run this instead:
# sudo dpkg -i <file>.deb
# sudo apt-get install -f # Install dependencies

    Where <file> is the name of the binary that was downloaded in step 1.

    environment 16
    Figure 116. Terminal command example

  3. Then update the package cache and install the package using:

    sudo apt install apt-transport-https
sudo apt update
sudo apt install code # or code-insiders
.Net Core SDK

Download and install .Net Core SDK:

  1. To install, open a terminal and run the following command:

    sudo apt-get update; \
sudo apt-get install -y apt-transport-https && \
sudo apt-get update && \
sudo apt-get install -y dotnet-sdk-6.0
    If you receive an error message similar to Unable to locate package dotnet-sdk-6.0, see the APT troubleshooting section of the official documentation.

  2. To verify the installation, open a terminal and enter the following command:

    dotnet --version
    environment 17
    Figure 117. CMD dotnet command
This guide is intended for Ubuntu/Debian distributions; if you are using another Linux distribution, please refer to the Official Microsoft Documentation
OmniSharp extension

Download and install C# extension (by OmniSharp):

  1. Open Visual Studio, go to the extensions section (1), search for C# extensions (2) and install the C# extension by OmniSharp:

    environment 12
    Figure 118. Extensions Site in Visual Code Studio
For MacOS
Visual Studio Code

Download and install Visual Studio Code:

  1. Download the latest version here

    environment 18
    Figure 119. Download Page

  2. Allow the download for this website by clicking the Allow button:

    environment 19
    Figure 120. Download Page

  3. Go to the Downloads folder and Drag Visual Studio Code.app to the Applications folder, making it available in the macOS Launchpad:

    environment 21
    Figure 121. MacOS Launchpad

  4. Launch Visual Studio Code:

    When you initially start Visual Studio Code, you must authorize the program to launch by clicking the open button.

    environment 20
    Figure 122. Opening VSCode
    Add VS Code to your Dock by right-clicking on the icon, located in the Dock, to bring up the context menu and choosing Options, Keep in Dock
.Net Core SDK

  1. Download .Net 6.0 SDK for your cpu architecture (x64 or Arm64).

    environment 22
    Figure 123. Download Page .Net 6.0

  2. Allow the download clicking the allow button in the next window:

    environment 23
    Figure 124. Download Page .Net 6.0

  3. Go to the downloads folder, open the downloaded installer, and click on the continue button:

    environment 24
    Figure 125. Microsoft .NET SDK Installer

  4. Select the destination disk where you want to install the Microsoft .NET SDK, and click continue:

    environment 25
    Figure 126. Microsoft .NET SDK Installer

  5. Click on the install button to perform a standard installation:

    environment 26
    Figure 127. Microsoft .NET SDK Installer

  6. Type your credentials and click the Install Software button to begin the installation:

    environment 27
    Figure 128. Microsoft .NET SDK Installer

  7. To verify the installation, open a terminal and enter the following command:

    dotnet --version
    environment 28
    Figure 129. CMD terminal command
OmniSharp extension

Download and install C# extension (by OmniSharp):

  1. Open Visual Studio, go to the extensions section (1), search for C# extensions (2) and install the C# extension by OmniSharp:

    environment 12
    Figure 130. Extensions Site in Visual Code Studio

Devon4net.Web.Api.Template

For Windows

  1. Open a project:

    • Open Visual Studio Code.

    • Click on the Explorer icon on the left menu and then click Open Folder.

    • Select the folder you want your C# project to be in and click Select Folder. For our example, we’ll create a folder for our project named 'ApiTest'.

  2. Initialize a C# project:

    • Open the Integrated Terminal from Visual Studio Code by typing Left CTRL + backtick. Alternatively, you can select View > Terminal from the main menu.

    • You must select Command Prompt instead of PowerShell:

      environment 13
      Figure 131. CMD in Visual Code Studio

    • In the terminal window, type:

      dotnet new -i Devon4Net.WebAPI.Template

    • This will install the Devon4Net.WebAPI.Template with the latest version, next to create your project you must run the following command.

      dotnet new Devon4NetAPI

  3. Run the "ApiTest" program:

    • Go to the path where the Program.cs file is found typing the following command:

      cd Templates\WebAPI\Devon4Net.Application.WebAPI

      And then type:

      dotnet run

    • You can now test the template by going to the swagger page at: https://localhost:8085/swagger/index.html.

You may now start working with C# and the devon4net api template in the Visual Studio Code environment.

For Linux Systems

  1. Open a project:

    • Open Visual Studio Code.

    • Click on the Explorer icon on the left menu and then click Open Folder.

    • Select the folder you want your C# project to be in and click Select Folder. For our example, we’ll create a folder for our project named 'ApiTest'.

  2. Initialize a C# project:

    • Open the Integrated Terminal from Visual Studio Code by typing Left CTRL + backtick. Alternatively, you can select View > Terminal from the main menu.

    • In the terminal window, type:

      dotnet new -i Devon4Net.WebAPI.Template

    • This will install the Devon4Net.WebAPI.Template with the latest version, next to create your project you must run the following command.

      dotnet new Devon4NetAPI

  3. Run the "ApiTest" program:

    • Go to the path where the Program.cs file is found typing the following command:

      cd Templates/WebAPI/Devon4Net.Application.WebAPI

      And then type:

      dotnet run

    • You can now test the template by going to the swagger page at: https://localhost:8085/swagger/index.html.

You may now start working with C# and the devon4net api template in the Visual Studio Code environment.

For MacOS

  1. Open a project:

    • Open Visual Studio Code.

    • Click on the Explorer icon on the left menu and then click Open Folder.

    • Select the folder you want your C# project to be in and click Select Folder. For our example, we’ll create a folder for our project named 'ApiTest'.

  2. Initialize a C# project:

    • Open the Integrated Terminal from Visual Studio Code by typing Left CTRL+ Left Shift + backtick. Alternatively, you can select View > Terminal from the main menu.

    • In the terminal window, type:

      dotnet new -i Devon4Net.WebAPI.Template

    • This will install the Devon4Net.WebAPI.Template with the latest version, next to create your project you must run the following command.

      dotnet new Devon4NetAPI

  3. Run the "ApiTest" program:

    • Go to the path where the Program.cs file is found typing the following command:

      cd Templates/WebAPI/Devon4Net.Application.WebAPI

      And then type:

      dotnet run

    • You can now test the template by going to the swagger page at: https://localhost:8085/swagger/index.html.

You may now start working with C# and the devon4net api template in the Visual Studio Code environment.

Troubleshoot

It’s possible that when you execute the program, you’ll get the following error:

Exception DevonWebAPI MacEnvironment

That is why Kestrel does not support HTTP/2 with TLS in macOS. To fix this, navigate to the appsettings.json file and disable the TLS protocol in the Kestrel server setup as follows:

{
  "devonfw": {
    "Kestrel": {
      "UseHttps": true,
      "HttpProtocol": "Http1AndHttp2", //Http1, Http2, Http1AndHttp2, none
      "ApplicationPort": 8085,
      "SslProtocol": "none", //Tls12, Tls13, none. For Https2 Tls12 is needed
    }
  }
}
HTTP/2 without TLS should only be used during app development. Production apps should always use transport security.

Debug

  1. Open for example Program.cs by clicking on it. The first time you open a C# file in Visual Studio Code, OmniSharp will load in the editor.

  2. To open the Debug view, click on the Debugging icon on the left side menu.

  3. Visual Studio Code will prompt you to add the missing assets to build and debug your app. Select Yes.

  4. Locate the green arrow at the top of the pane. Make sure the drop-down next to it has .NET Core Launch (web) selected.

  5. Add a breakpoint to your project by clicking on the editor margin (the space on the left of the line numbers in the editor).

  6. Select F5 or the green arrow to start debugging. The debugger stops execution of your program when it reaches the breakpoint you set in the previous step.

    • While debugging you can view your local variables in the top left pane or use the debug console.

  7. Select the green arrow at the top to continue debugging, or select the red square at the top to stop.

The following figure summarizes the most important points:

environment 14
Figure 132. Debug mode in Visual Code Studio

Where:

  1. Debug Section

  2. Launch button

  3. Break Point

  4. Debug Console

  5. Debug Navigation Buttons

For more information and troubleshooting tips on .NET Core debugging with OmniSharp in Visual Studio Code, see Instructions for setting up the .NET Core debugger.

.Net Core

Using .NET Core in Visual Studio Code

.Net Core in Visual Studio Code tutorial

↑ Up: Environment | ⌂ Home: devonfw guide | Next: Packages →

Last updated 2023-11-20 10:37:01 UTC