RD

Note: RD only works on mac at the moment.

This is in pre-alpha and needs to be run using developer tools.

Prerequisites

• Be on macos (note, expansion to other operating systems is planned)

• Node.js

• The following pre-requisites are needed by the vue testing framework.

• macos:

brew install pkg-config cairo pango libpng jpeg giflib librsvg

• ubuntu:

sudo apt-get install -y libcairo2-dev libpango1.0-dev libpng-dev libjpeg-dev libgif-dev librsvg2-dev

Windows

Experimental Windows support is in development.

Quick Start

1. Download a Microsoft Windows 10 development virtual machine.
2. Open a privileged PowerShell prompt (hit Windows Key + X and open Windows PowerShell (Admin)).
3. Run the automated setup script:

   Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
   
   iwr -useb 'https://github.com/rancher-sandbox/rd/raw/main/scripts/windows-setup.ps1' | iex
   

4. Close the privileged PowerShell prompt.

You are now ready to clone the repository and run npm install.

Manual Development Environment Setup

1. Download and install Visual Studio, taking care to install:
   • MSVC v141 - VS 2017 C++ x64/x86 build tools (v14.16)
   • MSVC v142 - VS 2019 C++ x64/x86 build tools (Latest)
2. Download the GTK+ Win64 bundle; it is recommended to install it in the default location at C:\GTK.
3. Download the libjpeg-turbo development files; it is recommended to install it in the default location at C:\libjpeg-turbo64.
4. Install git, Python 2.x, and NodeJS.
   1. Install Scoop via iwr -useb get.scoop.sh | iex
   2. Install git and nvm via scoop install git nvm
   3. Add the old versions bucket via scoop bucket add versions
   4. Install nvm and Python 2 via scoop install python27
   5. Install NodeJS via nvm install latest
      • Remember to use it by running nvm use $(nvm list)
5. Configure NPM to use the version of MSBuild installed:

   npm config set msbuild_path "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin\MSBuild.exe"
   

   Note that this is the default path; the path on your system may differ.

If you have customized the GTK and libjpeg paths, you will need to run npm install with the GYP_DEFINES variable set to point to them. In PowerShell, this would look something like:

$Env:GYP_DEFINES = 'GTK_Root="C:/Path/To/GTK" jpeg_root="C:/Path/To/libjpeg"'

How To Run

Use the following commands. The former is needed the first time or after an update is pulled from upstream. The latter is needed for follow-up starts.

npm install
npm run dev