jprdonnelly/steampipe
1
0
Fork 0
mirror of https://github.com/turbot/steampipe.git synced 2026-02-18 04:00:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update dashboard README to improve local dev instructions

Browse Source
This commit is contained in:
Jon Udell
2022-10-03 01:36:20 -07:00
committed by GitHub
parent 195069f619
commit 0f7eb540b6
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
ui/dashboard/README.md
View File

@@ -8,7 +8,7 @@ This will allow you to develop the dashboards UI locally. To get started:
## Start Steampipe
- Start your local Steampipe service with `steampipe service start` (ensure you have navigated to your mod folder with `cd <mod_folder>` first)
- Start your local Steampipe service, and dashboard service, with `steampipe dashboard` (ensure you have navigated to your mod folder with `cd <mod_folder>` first)
## UI Setup
@@ -50,4 +50,4 @@ Your default browser will open up the component library.
- Add a folder for the new hierarchy type and add `index.tsx`
- Ensure you call `registerComponent` before the export
- Import this new hierarchy in `ui/dashboard/src/utils/registerComponents.ts`
- Add Storybook stories for your component in `index.stories.js`
- Add Storybook stories for your component in `index.stories.js`