Skip to content

Commit 2bff24d

Browse files
authored
Update README.md
1 parent 7011419 commit 2bff24d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ In the standard configuration it embeds several capabilities:
3333
## Setup
3434

3535
### Fork
36-
We encourage you to [fork this repository ](https://github.com/transitiverobotics/transact/fork) and use it as a foundation stone for your awesome robotics app!
36+
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.
3737

3838
### Clone
39-
After forking clone transAct locally (replace `SUPERBOTS` with your github org)
39+
After forking, clone transAct locally (replace `SUPERBOTS` with your github org)
4040

4141
git clone git@github.com:SUPERBOTS/transact.git
4242

@@ -50,16 +50,16 @@ Your local transAct deployment will interface with a Transitive deployment to fi
5050

5151
1. Go to https://portal.transitiverobotics.com and create an account.
5252
1. In your local transAct clone, copy `sample.env` file to `.env` and edit it:
53-
- **VITE_TRANSITIVE_USER** is your Transitive username.
54-
- **JWT_SECRET** is the JWT secret from your Security page: https://portal.transitiverobotics.com/security.
53+
- **VITE_TRANSITIVE_USER** set this to your Transitive username, created in Step 1.
54+
- **JWT_SECRET** set this to your JWT secret found on your Security page: https://portal.transitiverobotics.com/security.
5555
1. Run `npm install` to install all dependencies.
5656

5757
### Run
58-
1. Run `npm run dev` to start transAct locally.
58+
1. Run `npm run dev` to start transAct locally in dev mode.
5959
2. Navigate to http://localhost:3000/.
60-
3. Enjoy!.
60+
3. Enjoy!
6161

62-
At first you won't see any robots on your dashboards. This is because you don't yet have any robots attached to your Transitive account on transitiverobotics.com. We'll do this next.
62+
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.
6363

6464
## Get some robots
6565
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.
@@ -69,7 +69,7 @@ Finally add some capabilities to the devices you've added from the [fleet page](
6969
Once these robots show up in the Transitive Portal, they will also appear in your local transAct deployment.
7070

7171
## Make it your own!
72-
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. 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 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.
72+
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.
7373

7474
### UI components
7575
This project uses [ShadCn](https://ui.shadcn.com/) project for UI components and [Tailwind CSS](https://tailwindcss.com/) for styling.

0 commit comments

Comments
 (0)