Skip to content
Madita Antonia Plogsties edited this page May 13, 2025 · 16 revisions

title: Getting Started

How do I run the code?

First intialization

  1. You will need git.
  2. You will need Node & npm.
  3. We use corepack for yarn, so run corepack enable in your command line
  4. In the root directory of the project run yarn install or yarn for short in your command line. This will download all used packages of the project.

Spinning up the server

After you have installed all components (see previous section), you only have to execute:

yarn run start

This will spin up a local server presenting the webpage.

Debugging

VSCode

Debugging features such as breakpoints, data inspection and stepping through code are built into VSCode and can be enabled as follows.

  1. Add the following configuration to .vscode/launch.json:
{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Debug React App",
      "type": "chrome",
      "request": "launch",
      "url": "http://localhost:3000",
      "webRoot": "${workspaceFolder}/src"
    }
  ]
}
  1. Start the local server
yarn run start
  1. Start debugging by pressing F5 in VSCode.

If I'm not working on rust, do I have to install it?

No. The Rust code is compiled to a wasm package. These compiled packages are in the git repository so when you clone/pull from the repository, you already have the compiled code. These wasm packages can be executed in your browser so you do not have to install something for it

Clone this wiki locally