Setup toolchain

Necessary tools

You will need the following tools:

• nodejs
• yarn
• rust (when you work on the repo database-layer)

Take the following versions:

• nodejs: Use the most recent version of the version which is mentioned in package.json in the keyword engines (see https://github.com/serlo/cloudflare-worker/blob/1bcbd91ec943daeecb042937b633c437ed7538c8/package.json#L92-L94 for an example which mentioned 16.x)
• yarn: Use the most recent version
• rust: Use stable

See how to install each one of these for your OS.

Installing asdf

You could use asdf-vm for installing the tools you need (like NodeJS or Rust). Follow the instructions to install asdf on their site "Getting started".

In order to install a tool you need to run the following commands:

# Install the asdf plugin for the tool, like `nodejs`
asdf plugin add <tool-name>

# List all available versions for the tool
asdf list all <tool-name>

# Install the tool in the version you need
asdf install <tool-name> <version>

Make yourself familiar on how you can set a version with asdf. When you use the asdf local variant make sure, that you have .tool-versions in your global .gitignore file.

For installing yarn the necessary command might look like:

asdf plugin add yarn
asdf list all yarn
asdf install yarn 1.22.18
asdf global yarn 1.22.18

Cloning the repository

Clone the repository you want to work in. Follow the instructions in the README.md for setting up the work environment.

Setup of editor

• VSCode for TypeScript: https://github.com/serlo/frontend/wiki/VS-Code
• WebStorm for TypeScript: https://www.jetbrains.com/webstorm/

In WebStorm you can install a plugin for GraphQL.

TODO: Write instructions for setting up VScode / intelij / nvim