Setup for Windows

Note that: Visual Studio Code is not a requirement per say, but is strongly recommended as a common code editor for this project. If you feel like using something else you are free to do so, but be aware that this can cause issues/headaches. Also be sure to add any unwanted files or directories that your code editor might create to the .gitignore file, as to not clutter the project.

Also note that: Windows is special and our project requires that all dependencies can be access through the command line. In Windows, this is done by adding it to the PATH. In every dependency, if there is an option to add it to the PATH, be sure to do so.

OS specific links to downloading dependencies:

• Visual Studio Code
• Docker Desktop
• Node
• Dotnet
• Git

Visual Studio Code (VSC)

1. Download and run the installer.
2. Launch Visual Studio Code.
3. Install required extensions:
   • Search and install the "C# Dev Kit" in the extensions tab in VSC.

If you have come this far, you have verified that VSC works.

Docker

Download the installer and follow the installation instructions up to step 6.

To verify that it works, open your favorite CLI and use:

docker --version
docker compose version

It works correctly if these return version numbers.

Node

Download and run the installer. Be sure to not install it using Docker (it's an option in the installer).

To verify that it works, open your favorite CLI and use:

node --version
npm --version

It works correctly if these return version numbers.

Dotnet

Download the installer (be sure to pick SDK 10.0) and follow the installation instructions up to step 7.

To verify that it works, open your favorite CLI and use:

dotnet --info

It works correctly if this return a version number.

Git

With Git you have two options. Either you can use the Git CLI to do everything, or you can use a GUI for your Git. In this project we strongly recommend using a GUI as it is easier. We specifically recommend GitHub Desktop. But both installations will be covered below.

Git CLI

It can be downloaded here via several methods.

Run the installer. It has many options but leaving everything as defaults works fine.

To verify that it works, open your favorite CLI and use:

git --version

It works correctly if this return a version number.

GitHub Desktop

GitHub Desktop can be found here.

Run the installer. The Git CLI is installed as a part the GUI version and is thus verified the same way.

Continuation

Continue here for setup of the project environment.