Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Teo Koon Peng <[email protected]>
  • Loading branch information
koonpeng committed Oct 18, 2024
1 parent 15eab8b commit 7f2f570
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
5 changes: 3 additions & 2 deletions packages/rmf-dashboard-framework/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,15 @@ The `layout` property defines the position and size of a MicroApp, the screen is

You shouldn't need to do this for local testing, but for reference, the example uses vite, an optimized production build can be created with

<!-- FIXME(koonpeng) `pnpm tsc -b` fails possibly because of react-three-fiber-hack.d.ts (but pnpm tsc succeed). This may or may not be due to the hacky symlink, need to test if it works as an external package. If it doesn't work, then we have to publish transpiled js, the downside is that the examples will no longer work with HMR (unless we run tsc in watch mode in the background) -->
```bash
# cd <basic-dashbaord-root>
# cd <basic-dashboard-root>
pnpm vite build
```

There is no dev server for a production build, you will need a web server to access it.

```bash
# not recommended in production!
pnpx serve -s build
pnpx serve -s dist
```
3 changes: 0 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7f2f570

Please sign in to comment.