Skip to content

Commit ee2b02d

Browse files
Teo Koon PengAngatupyry
authored andcommitted
build: switch to pnpm; switch to ros humble (open-rmf#628)
Signed-off-by: Teo Koon Peng <[email protected]> Signed-off-by: Angatupyry <[email protected]>
1 parent 5370213 commit ee2b02d

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77
### Ubuntu 22.04
88

99
Install nodejs
10+
1011
```bash
1112
sudo apt update && sudo apt install curl
1213
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
1314
nvm install 16
1415
```
1516

1617
Install pnpm and nodejs
18+
1719
```bash
1820
curl -fsSL https://get.pnpm.io/install.sh | bash -
1921
pnpm env use --global 16
@@ -23,46 +25,44 @@ pnpm env use --global 16
2325

2426
Refer to the following documentation:
2527

26-
* [rmf](https://github.com/open-rmf/rmf)
28+
- [rmf](https://github.com/open-rmf/rmf)
2729

2830
### Others
2931

3032
Refer to the following documentations:
3133

32-
* [nodejs](https://nodejs.org/en/download/package-manager/) >= 16
33-
* [rmf_demos](https://github.com/open-rmf/rmf_demos)
34+
- [nodejs](https://nodejs.org/en/download/package-manager/) >= 16
35+
- [rmf_demos](https://github.com/open-rmf/rmf_demos)
3436

3537
## Install dependencies
3638

37-
For Debian/Ubuntu systems, you may need to install `python3-venv` first.
38-
```bash
39-
sudo apt install python3-venv
40-
```
41-
42-
Run
4339
```bash
4440
pnpm install
4541
```
4642

4743
You may also install dependencies for only a subset of the packages
44+
4845
```bash
4946
pnpm install -w --filter <package>...
5047
```
5148

5249
### PostgreSQL
50+
5351
If you would like to use PostgreSQL, you will also need to install and set it up. The defaults are for PostgreSQL to be listening on 127.0.0.1:5432.
5452

5553
#### Docker
54+
5655
We can use Docker to quickly bring up a PostgreSQL instance.
5756

5857
Install docker: `https://docs.docker.com/engine/install/ubuntu/`
5958
Start a a database instance: `docker run -it --rm --name rmf-postgres --network=host -e POSTGRES_PASSWORD=postgres -d postgres`
6059

6160
To stop the instance: `docker kill rmf-postgres`
6261

63-
6462
#### Bare Metal
63+
6564
Alternatively, we can install PostgreSQL 'bare metal'.
65+
6666
```
6767
apt install postgresql postgresql-contrib -y
6868
# Set a default password
@@ -72,18 +72,22 @@ sudo systemctl restart postgresql
7272
# interactive prompt
7373
sudo -i -u postgres
7474
```
75+
7576
To manually reset the database:
77+
7678
```
7779
sudo -u postgres bash -c "dropdb postgres; createdb postgres"
7880
```
7981

8082
## Launching
8183

8284
Before running the commands, make sure that rmf is sourced.
85+
8386
```bash
8487
cd packages/dashboard
8588
pnpm start
8689
```
90+
8791
When presented with a login screen, use `user=admin password=admin`.
8892

8993
This launches a development server with the office world from `rmf_demos`. The server is useful for development but is obviously not useful for actual usage.
@@ -93,6 +97,7 @@ This launches a development server with the office world from `rmf_demos`. The s
9397
See the [rmf-dashboard](packages/dashboard/README.md#configuration) docs.
9498

9599
## Troubleshooting
100+
96101
First thing to try is to build rmf from source, in order to speed up development, `rmf-web` may use in-development features of rmf. That means that the binary releases may not have the features required, sometimes the features `rmf-web` uses may be so new that not even the rolling releases has it.
97102

98103
Refer to [rmf_demos](https://github.com/open-rmf/rmf_demos) for instructions to build rmf. You should end up with a colcon workspace with all of rmf packages, remember to source the workspace before running any of the commands.

0 commit comments

Comments
 (0)