From 658930ef91add98f7f6184e2d99c3dfd452189ad Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 5 Sep 2024 02:36:44 +0000 Subject: [PATCH] simplify getting started setup Signed-off-by: Teo Koon Peng --- .../docs/getting-started.md | 17 +++++------------ .../src/components/rmf-dashboard.tsx | 2 -- .../src/micro-apps/index.tsx | 2 +- 3 files changed, 6 insertions(+), 15 deletions(-) diff --git a/packages/rmf-dashboard-framework/docs/getting-started.md b/packages/rmf-dashboard-framework/docs/getting-started.md index 5ef1c1cb8..3e14652e7 100644 --- a/packages/rmf-dashboard-framework/docs/getting-started.md +++ b/packages/rmf-dashboard-framework/docs/getting-started.md @@ -24,20 +24,13 @@ git clone --depth 1 https://github.com/open-rmf/rmf-web ``` -Add modify the following to resolve `rmf-dashboard-framework` as if it is installed from npmjs. - -pnpm-workspace.yaml (create if not exist) -```yaml -packages: - - "." - - "rmf-web/**/*" -``` +Modify the following to resolve `rmf-dashboard-framework` as if it is installed from npmjs. package.json ``` "dependencies": { ... - "rmf-dashboard-framework": "workspace:*" + "rmf-dashboard-framework": "rmf-web/packages/rmf-dashboard-framework" } ``` @@ -51,9 +44,9 @@ tsconfig.app.json Finally install and build the deps ```bash -# TODO(koonpeng): -w flag not needed after rmf-dashboard-framework is published -pnpm install --filter basic-dashboard... -pnpm --filter basic-dashboard^... build +cd rmf-web +pnpm install --filter=rmf-dashboard-framework... +pnpm --filter=rmf-dashboard-framework^... build ``` ### Creating a Basic Dashboard diff --git a/packages/rmf-dashboard-framework/src/components/rmf-dashboard.tsx b/packages/rmf-dashboard-framework/src/components/rmf-dashboard.tsx index 974b88d3f..84fa896c4 100644 --- a/packages/rmf-dashboard-framework/src/components/rmf-dashboard.tsx +++ b/packages/rmf-dashboard-framework/src/components/rmf-dashboard.tsx @@ -32,8 +32,6 @@ import { DashboardThemes } from './theme'; const DefaultAlertDuration = 2000; -export interface DashboardHome {} - export interface DashboardTab { name: string; route: string; diff --git a/packages/rmf-dashboard-framework/src/micro-apps/index.tsx b/packages/rmf-dashboard-framework/src/micro-apps/index.tsx index 2ab25e8a1..dbbb31505 100644 --- a/packages/rmf-dashboard-framework/src/micro-apps/index.tsx +++ b/packages/rmf-dashboard-framework/src/micro-apps/index.tsx @@ -1,7 +1,7 @@ import React, { Suspense } from 'react'; -import { useAppController } from 'rmf-dashboard-framework/hooks/use-app-controller'; import { Window, WindowProps } from '../components/window'; +import { useAppController } from '../hooks/use-app-controller'; import { useSettings } from '../hooks/use-settings'; import { Settings } from '../services/settings';