Developer guide

Developer guide

Running RDUI locally

You need to install following packages: nodejs, npm, yarn. If you are using Ubuntu you can't install new version of nodejs(it will be very old in official repos).

This guide will describe installation on Ubuntu(Debian based dist). So, lets install latest stable version of node

sudo apt install nodejs npm
sudo npm cache clean -f
sudo npm install -g n
sudo n stable

Install yarn

npm install --global yarn

Now, download source code of master tree of this repo

git clone https://github.com/robotx-school/robot-develop-ui && cd robot-develop-ui

Install required packages:

yarn install

Start development version of RDUI (live reload and other features)

yarn start

For production build run (files can be find in build directory)

yarn build

Versions and releases

In footer of RDUI you can find some debug info: RDUI version, Connected robot status, RDUI build type, robot API compatibility.

• RDUI version - version of RDUI, you can change it in package.json
• Connected robot status - if current RDUI tab connected to robot http api you will see green robot ipv4, otherwise red text
• RDUI build type - can be Local build if running by yarn start or Production build if running on our trustable domain - fos.robotx.su
• Robot API compatibility - versions ranges of robot http api which will be correctly works with RDUI. RDUI will notify you if you are trying to connect to unsupported http api version. Range can be defined in two ways: x.x.x-y.y.y or >=x.x.x

To find stable and built version of RDUI, please refer to release section. There you can find fully tested and stable (expected behaviour) RDUI version to deploy on your server.