https://github.com/flora-suite/flora
Flora is an integrated visualization and diagnosis tool for robotics, available in your browser or as a desktop app on Linux, Windows, and macOS
https://github.com/flora-suite/flora
flora mcap ros rviz visualization webviz
Last synced: 12 months ago
JSON representation
Flora is an integrated visualization and diagnosis tool for robotics, available in your browser or as a desktop app on Linux, Windows, and macOS
- Host: GitHub
- URL: https://github.com/flora-suite/flora
- Owner: flora-suite
- License: mpl-2.0
- Created: 2024-11-14T14:45:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-11T15:26:47.000Z (about 1 year ago)
- Last Synced: 2025-06-11T16:51:42.082Z (about 1 year ago)
- Topics: flora, mcap, ros, rviz, visualization, webviz
- Language: TypeScript
- Homepage: https://app.flora.fan
- Size: 10.7 MB
- Stars: 25
- Watchers: 2
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Flora
Flora is an integrated visualization and diagnosis tool for robotics, available in your browser or as a desktop app on Linux, Windows, and macOS.
## How to install
### macos
```shell
brow tab flora-suite/homebrew-flora
brew install flora
```
### windows and linux
go to [Download](https://github.com/flora-suite/flora/releases)
**Dependencies:**
- [Node.js](https://nodejs.org/en/) v16.10+
## :rocket: Getting started
Clone the repository:
```sh
$ git clone https://github.com/flora-suite/flora.git
```
Enable corepack:
```sh
$ corepack enable
```
Install packages from `package.json`:
```sh
$ yarn install
```
- If you still get errors about corepack after running `corepack enable`, try uninstalling and reinstalling Node.js. Ensure that Yarn is not separately installed from another source, but is installed _via_ corepack.
Launch the development environment:
```sh
# To launch the desktop app (run scripts in different terminals):
$ yarn desktop:serve # start webpack dev server
$ yarn desktop:start # launch electron (make sure the desktop:serve finished to build)
# To launch the web app:
$ yarn run web:serve # it will be avaiable in http://localhost:8080
```
:warning: Ubuntu users: the application may present some issues using GPU. In order to bypass the GPU and process it using directly the CPU (software), please run flora using the variable `LIBGL_ALWAYS_SOFTWARE` set to `1`:
```sh
$ LIBGL_ALWAYS_SOFTWARE=1 yarn desktop:start
```
## :hammer_and_wrench: Building Flora
Build the application for production using these commands:
```sh
# To build the desktop apps:
$ yarn run desktop:build:prod # compile necessary files
- yarn run package:win # Package for windows
- yarn run package:darwin # Package for macOS
- yarn run package:linux # Package for linux
# To build the web app:
$ yarn run web:build:prod
# To build and run the web app using docker:
$ docker build . -t flora
$ docker run -p 8080:8080 flora
# It is possible to clean up build files using the following command:
$ yarn run clean
```
- The desktop builds are located in the `dist` directory, and the web builds are found in the `web/.webpack` directory.
## :pencil: License (Open Source)
Flora follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE).
## :handshake: Contributing
Contributions are welcome! Flora is primarily built in TypeScript and ReactJS. All potential contributors must agree to the Contributor License Agreement outlined in [CONTRIBUTING.md](CONTRIBUTING.md).
## :star: Credits
Flora is based on the [Lichtblick](https://github.com/Lichtblick-Suite/lichtblick) open source code.
Lichtblick originally began as a fork of [Foxglove Studio](https://github.com/foxglove/studio), an open-source project developed by [Foxglove](https://foxglove.dev/).