https://github.com/transitiverobotics/transact
An Open-source Robot Fleet Management Dashboard
https://github.com/transitiverobotics/transact
dashboard robotics ros
Last synced: 5 months ago
JSON representation
An Open-source Robot Fleet Management Dashboard
- Host: GitHub
- URL: https://github.com/transitiverobotics/transact
- Owner: transitiverobotics
- License: apache-2.0
- Created: 2024-10-11T04:00:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-20T16:52:31.000Z (7 months ago)
- Last Synced: 2025-06-08T04:28:03.802Z (6 months ago)
- Topics: dashboard, robotics, ros
- Language: TypeScript
- Homepage: https://transitiverobotics.com/
- Size: 290 KB
- Stars: 49
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-weekly-robotics - transAct - An open-source robot fleet management dashboard. License: Apache-2.0. (ROS / ROS web tools/frameworks)
README
# transAct
#### An open-source robot fleet management dashboard
by
Transitive Robotics
TransAct is an example of the kinds of robot fleet management dashboards/cloud portals/mission control centers/robot operating centers you can build using Transitive. It serves three purposes:
1. demonstrate how [Transitive](https://github.com/transitiverobotics/transitive) can be used to build web-based robot management systems,
1. demonstrate how to integrate [Transitive Capabilities](https://transitiverobotics.com/caps/) into your own web dashboards, and
1. serve as a reference implementation that we invite you to fork and build on if you are just starting out building your own system.
We believe that robotics companies face a [make-vs-buy dilemma](https://transitiverobotics.com/blog/make-vs-buy/) and our mission is to solve this by offering a middle-ground: making it easy for them to build their own fleet management system that perfectly meets their needs.
In the standard configuration it embeds several capabilities:
- [Remote Teleop](https://transitiverobotics.com/caps/transitive-robotics/remote-teleop/), to control your robot with low-latency video from anywhere in the world,
- [Terminal](https://transitiverobotics.com/caps/transitive-robotics/terminal/), for web-based shell access,
- [ROS Tool](https://transitiverobotics.com/caps/transitive-robotics/ros-tool/), for subscribing to ROS topics from the web, used to show robot pose, battery and charging status in our example, and make service calls,
- [Configuration Management](https://transitiverobotics.com/caps/transitive-robotics/configuration-management/), for editing config files on your fleet hierarchically (with fleet defaults and robot specific overwrites), and
- [Health Monitoring](https://transitiverobotics.com/caps/transitive-robotics/health-monitoring/), for monitoring device diagnostics and aggregated fleet diagnostics.
## Setup
### Fork
We encourage you to [fork this repository](https://github.com/transitiverobotics/transact/fork) and use it as a starting point to build your own dashboard.
### Clone
After forking, clone transAct locally (replace `SUPERBOTS` with your github org)
git clone git@github.com:SUPERBOTS/transact.git
Or you can just clone from this repo directly if you're just taking a look
git clone git@github.com:transitiverobotics/transact.git
### Configure
Your local transAct deployment will interface with a Transitive deployment to find robots and capabilities.
1. Go to https://portal.transitiverobotics.com and create an account.
1. In your local transAct clone, copy `sample.env` file to `.env` and edit it:
- **VITE_TRANSITIVE_USER** set this to your Transitive username, created in Step 1.
- **JWT_SECRET** set this to your JWT secret found on your Security page: https://portal.transitiverobotics.com/security.
1. Run `npm install` to install all dependencies.
### Run
1. Run `npm run dev` to start transAct locally in dev mode.
2. Navigate to http://localhost:3000/.
3. Enjoy!
At first you won't see any robots on your dashboard. This is because you haven't yet added any robots to your Transitive account on transitiverobotics.com. We'll do this next.
## Get some robots
Follow the [instructions](https://transitiverobotics.com/docs/guides/getting-started/ "Getting started") to add robots to your Transitive account. If you just want to see it working quickly you can use our example Docker image. Go to [fleet page](https://portal.transitiverobotics.com/ "Fleet page"), down to the end of the **Add devices** section and you'll find a command you can grab to run a local Docker robot.
Finally add some capabilities to the devices you've added from the [fleet page](https://portal.transitiverobotics.com/ "Fleet page")
Once these robots show up in the Transitive Portal, they will also appear in your local transAct deployment.
## Configure capabilities
Edit `src/client/config/config.ts` to set the Transitive capabilities you have installed on your robots (e.g., webrtc-video) and the props you want to use for them (see the Embed in the Transitive Portal after you've configured a capability).
## Make it your own!
The code is yours! A good first step is to find and replace "SuperBots" in the entire project with the name of your own company and change the logo. After that you'll probably want to go through the sections in `src/client/sections` and edit the properties of the embedded Transitive capabilities to fit your needs, e.g., choose the right video sources (cameras, ROS topics, etc.) for webrtc-video and remote-teleop. The easiest way to do this is to go to your Transitive Portal page, open the capability there, configure it, and then get the pre-configured React code from the "Embed" modal.
### UI components
This project uses [ShadCn](https://ui.shadcn.com/) project for UI components and [Tailwind CSS](https://tailwindcss.com/) for styling.
You have a lot of beautiful components to choose from in the [ShadCn](https://ui.shadcn.com/docs/components/accordion) collection, you can find instructions on how to use them there, but as an example, if you need a Slider component in your app you just need to:
npx shadcn@latest add slider
Once it's installed (it just gets copied in the *client/components/ui* folder) you can use it like this:
```jsx
import { Slider } from "@/components/ui/slider"
...
Robot happiness
```
Note that the `className="text-xl"` is from [tailwindcss](https://tailwindcss.com/docs/font-size).
## Getting help
Questions? [Join our Slack](https://transitiverobotics.com/slack) and we'll try to help. For suggestions, please open issues or pull-requests.
-----
#### Attribution
SuperBots Logo: Robot icons created by Freepik - Flaticon