adambullmer/studio

Robotics visualization and debugging

Foxglove Studio

Foxglove Studio (foxglove.dev) is an integrated visualization and diagnosis tool for robotics.

Installation

Visit foxglove.dev/download or GitHub Releases to download the latest version.

Support

• Documentation
• GitHub Discussions
• Slack Community
• @foxglovedev on Twitter

Contributing

Contributions are welcome! Foxglove Studio is primarily written in TypeScript, the instructions below should help you get started:

Supported development environments: Linux, Windows, macOS

Required dependencies:

• Node.js v14+
• Yarn (npm install -g yarn)
• Git LFS
• Visual Studio Code (recommended)

Getting started:

1. Clone git repo
2. Run yarn install
3. Launch the development environment (run both scripts concurrently):

$ yarn serve        # start webpack
$ yarn start        # launch electron

# Advanced usage: running webpack and electron on different computers (or VMs) on the same network
$ yarn serve --host 192.168.xxx.yyy         # the address where electron can reach the webpack dev server
$ yarn dlx electron@13.0.0-beta.13 .webpack # launch the version of electron for the current computer's platform

Other useful commands:

$ yarn run          # list available commands
$ yarn lint         # lint all files
$ yarn test         # run all tests
$ yarn test:watch   # run tests on changed files

About

Foxglove Studio began as a fork and evolution of Webviz, an open source project developed by Cruise.

To learn more about Foxglove, visit foxglove.dev/about or view our documentation and release notes.