tools-setup.md

Tools Setup

Note

We recommend using Linux or macOS for this course, we also support Windows but typically people have more trouble getting everything working correctly on Windows and it's harder for us to help them since we don't use Windows ourselves.

On Windows, if your username has spaces or special characters in it, the IDE might not work properly. Please create a new user with a username containing only letters.

Step 1: Create an account on gitlab.epfl.ch

If you haven't already log into gitlab and fill in this form with your GASPAR and SCIPER number to initialize your GitLab repository for the course. Do this as soon as possible because it will take some time between the account creation and the lab submission system working for your account.

Step 2: Installing the Java Development Kit (JDK) and sbt via coursier

We will use coursier to install the correct version of Java as well as the sbt build tool:

On Linux and macOS

curl -fLo cs https://git.io/coursier-cli-"$(uname | tr LD ld)"

chmod +x cs

./cs setup -y --jvm 8 --apps cs,sbt

Please reboot after this point.

On Windows

Download and install both the Visual C++ 2010 SP1 Redistributable Package and Visual C++ 2015 Redistributable Update (click on "Download" then select "vcredist_x64.exe" and click "Next").

Open cmd.exe (and not powershell)

First, make sure that you are not in the System32 directory, instead you should be in C:\Users\yourusername. If you are in System32 you will need to change directory to your user directory every time you start a terminal by running:

cd %USERPROFILE%

Now assuming that you're in the correct directory you can run:

bitsadmin /transfer cs-cli https://git.io/coursier-cli-windows-exe "%cd%\cs.exe"

.\cs setup -y --jvm 8 --apps cs,sbt

(This command might cause your anti-virus to misidentify cs.exe as a virus, please override that, that might require temporarily turning off your anti-virus during this setup).

If this command fails with Error running powershell script, use the following alternative instructions (if the command didn't fail, continue to the next step):

1. Run .\cs setup --jvm 8 --apps cs,sbt, at every question answer "n" and press Enter.
2. The last question should look like "Should we add C:\...\bin to your PATH?", please copy the C:\...\bin part here.
3. Edit the Path environment variable and paste the path you just copied to it, see https://www.architectryan.com/2018/08/31/how-to-change-environment-variables-on-windows-10/ and make sure the path you're adding is the first entry in the Path environment variable.
4. Start a new cmd.exe and continue with the rest of the instructions

In case of errors please ask on Discord or Gitlab issues for help, but don't try to run commands as Administrator as this will likely cause further issues!

Please close this terminal and open a new one after this point.

Step 5: Installing git

git is a version control system.

On Ubuntu and Debian

sudo apt update && sudo apt install git

On macOS

First, install the Homebrew package manager if it is not already installed:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Use Homebrew to install git:

brew install git

On Windows

Download and install git from https://git-scm.com/downloads. Once git is installed, open a new terminal and run:

git config --global core.autocrlf false

If this command worked it will not print anything.

Step 6: Installing Code

Visual Studio Code is the IDE we strongly recommend using for this class (you are free to use any editor you want, but we won't don't have the resources to help you configure it for Scala).

On Linux

See https://code.visualstudio.com/docs/setup/linux

On macOS

If you don't already have Code installed:

brew install --cask visual-studio-code

If it was already installed before, you will need to enable launching it from the command line.

On Windows

See https://code.visualstudio.com/docs/setup/windows. Make sure that the checkbox "Add to PATH (available after restart)" in the installer is checked.

Step 7: Installing the Scala support for Code

Open a new terminal and run:

code --install-extension lampepfl.dotty-syntax

If you're on Windows and the command is not found, try closing and restarting the terminal, if that doesn't work

Step 8: Generate a public/private SSH key pair

To submit labs, you will need an SSH key. If you don't already have one, here's how to generate it:

Step 8.1: Installing OpenSSH

On Ubuntu and Debian

sudo apt update && sudo apt install openssh-client

On macOS

Nothing to do, OpenSSH is pre-installed

On Windows

Follow the instructions under "Enable OpenSSH Client in Windows 10" on https://winaero.com/blog/enable-openssh-client-windows-10/

Step 8.2: Generating the key pair

Please follow this tutorial to generate a new SSH key and add it to the ssh-agent (except the last step: you should instead add the key to Gitlab as described below). This video (from 1:07 to 4:05) might also help.

Step 8.3: Adding your public key on Gitlab

To be able to push your code, you'll need to add the public part of your key on Gitlab:

• Go to gitlab.epfl.ch, log in with your EPFL account
• Go to gitlab.epfl.ch/-/profile/keys and copy-paste the content of the id_rsa.pub file created by the ssh-keygen command you just ran (ssh-keygen prints the location of the file to the console).
• Press Add key

Step 9: Follow the example lab

Time to do the example lab!