Environment Setup

Guide Source Code

Go to the QuickStart guide project to see the source code for a fully working example of this quick start guide.

Before creating a Velaptor project, you'll need two things: the .NET SDK and an IDE (Integrated Development Environment). This page will walk you through installing both.

Step 1: Install the .NET SDK

Velaptor is built on .NET, so you'll need the .NET SDK installed. The SDK includes the dotnet CLI tool used to create, build, and run projects.

Install instructions of the SDK are provided for each operating system from the official SDK download page. Use the provided links to install the SDK for your chosen operating system.

Once complete, open the terminal for your operating system and verify the installation using the following command:

dotnet --version

Step 2: Install an IDE

Choose one of the following IDEs to write and run your Velaptor project. All three are excellent choices — pick whichever you're most comfortable with.

Visual Studio Community

Visual Studio Community is a free, full-featured IDE from Microsoft for Windows.

1. Download Visual Studio Community from the link above.
2. Run the installer.
3. In the Workloads tab, select .NET desktop development.
4. Click Install and wait for installation to complete.
5. Launch Visual Studio and sign in with a Microsoft account (free).

tip

Visual Studio Community includes built-in NuGet package management, debugging, and project templates — all of which you'll use throughout this quick start.

JetBrains Rider

JetBrains Rider is a cross-platform .NET IDE available on Windows, Linux, and macOS.

1. Download Rider from the link above.
2. Run the installer and follow the setup wizard.
3. On first launch, Rider will detect your installed .NET SDK automatically.

note

Rider requires a license after the free trial period. JetBrains offers free licenses for students and open-source contributors.

Visual Studio Code

Visual Studio Code is a free, lightweight editor available on Windows, Linux, and macOS.

1. Download VS Code from the link above.
2. Run the installer and follow the prompts.

3. Open VS Code and install the C# Dev Kit extension:

   • Open the Extensions view (Ctrl+Shift+X).
   • Search for C# Dev Kit and click Install.

The C# Dev Kit extension provides project management, IntelliSense, debugging, and NuGet package management for .NET projects.

You're all set! Continue to the next page to create your Velaptor project.