Usage

A deployment of the latest stable version is available at https://rapyuta-robotics.github.io/zethus/ Just connect to a websocket endpoint and click on Add Visualization

---

Running locally

Development version

You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.
To start the user interface locally in dev mode, run the following commands:

npm install
npm start

Production version

The production version can be run locally with either docker or by building from source.
Running the docker container:

docker build -t=zethus .
docker run -p 8080:8080 zethus

Building the source:

npm install
npm run build

Then start a server in build directory. You can use serve npm package or any similar software

---

Usage in other React application

The npm package needs to be added as dependency

npm install --save zethus

Zethus can then be added to the application with an initial configuration (using zethus/src/zethus) or as a declarative component with configuration as props (using zethus/src/panels)

import Zethus from 'zethus'; // or import Zethus from 'zethus/dist/panels';
...
render() {
  return (
    <Zethus configuration={configuration} />
  )
}

Details of configuration can be found in the corresponding wiki page.

---

Usage in a Non-React application

A detailed overview of integrating a React component in Non-React applications is available on React Docs
To summarize, here is the syntax for adding it to a container with ID container:

ReactDOM.render(
  <Zethus configuration={configuration} />,
  document.getElementById('container')
);