Setup for Linux

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: This guide will mainly consist of guides for Debian-based (Ubuntu, Debian, Mint), Fedora, and Arch Linux systems.

OS specific links to downloading dependencies:

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

Visual Studio Code (VSC)

To download VSC for Linux, one has multiple alternatives.

The simplest of which would be to use Snapp or Flatpack.

If a manual installation is preferred, check the official VS Code website and install the version that fits the targeted system.

Once VSC is downloaded, be sure to add the required extensions:

• "C# Dev Kit"

Docker (Desktop)

In Linux it is recommended to simply use the Docker CLI instead of using the Desktop version as only Docker Engine is needed for this project. Read the installation details on Dockers webpage.

If the Desktop is still preferable follow the installation guide for Docker Desktop.

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

The version of dotnet that is being used is “10.0”.

The official download page is this page. It is highly recommended to run the install script and or follow the instructions given.

For Arch-based systems, the package can be found at archlinux.org/packages.

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

dotnet --info

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

On most Linux distros Git is installed by default. Verify it first by opening your favorite CLI and use:

git --version

It is installed if this return a version number.

If it doesn't, it should be available to download via your package manager as git. Instructions available here

Github desktop

GitHub Desktop does not have an offical version for Linux, but some alternatives do exist:

• There is a flatpak version of it found here.
• An older Ubuntu guide to install can be found at this gist.
• For Arch users it can be found on AUR.

It is verified that same way Git CLI is verified.

Continuation

Continue here for setup of the project environment.