README.md

ros_bt_py_web_gui

Vue3 implementation of the ros_bt_py web gui. This is to act as a replacement for the react gui.

Project Setup

yarn install

Compile and Hot-Reload for Development

yarn dev --host

Type-Check, Compile and Minify for Production

yarn build

Lint with ESLint

yarn lint

Format with Prettier

yarn format

Development Setup

ROS2 Components

This GUI requires a running instance of ros_bt_py for ROS2 with a running web gui. During development a different port will be used so it should not conflict with gui shipped with ros_bt_py.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.