jprdonnelly/steampipe
1
0
Fork 0
mirror of https://github.com/turbot/steampipe.git synced 2026-05-07 15:01:56 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
aa8a4ca45dee718be08220e7fe7526d1cd3a2aad
steampipe/ui/dashboard
History
dependabot[bot] 8eb1e0884c Bump follow-redirects from 1.15.5 to 1.15.6 in /ui/dashboard (#4194) 
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.5 to 1.15.6.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.5...v1.15.6)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-15 11:40:09 +00:00
..
.storybook
Further graph improvements #2708 (#2777)
2022-11-22 10:32:25 +00:00
public
Improve appearance and position of dashboard panel controls #2663.
2022-11-28 16:11:30 +00:00
scripts
Fix linting warnings
2023-07-06 16:08:23 +01:00
src
Include MarkLineComponent in echarts build. Closes #3740.
2023-08-10 16:15:36 +01:00
craco.config.js
Fix circular dependencies in dashboard UI causing storybook to fail. Fixes #2239. (#2240)
2022-07-12 22:55:37 +01:00
Makefile
Dashboard UI material symbol names should use snake case rather than kebab case #2828
2022-12-23 22:54:55 +00:00
package.json
Update dashboard UI dependencies. Closes #3851
2023-09-15 11:53:01 +01:00
postcss.config.js
Rename ui report folder to dashboard #1459.
2022-02-18 15:33:19 +00:00
README.md
Update dashboard README to improve local dev instructions
2022-10-03 09:36:20 +01:00
spec.md
Rename ui report folder to dashboard #1459.
2022-02-18 15:33:19 +00:00
tailwind.config.js
Don't use custom theme color yellow for severity cards, to avoid clashing with Tailwind's yellow palette. Fixes #3501.
2023-05-30 15:45:56 +01:00
tsconfig.json
Rename ui report folder to dashboard #1459.
2022-02-18 15:33:19 +00:00
yarn.lock
Bump follow-redirects from 1.15.5 to 1.15.6 in /ui/dashboard (#4194)
2024-03-15 11:40:09 +00:00

README.md

Steampipe Dashboards

This will allow you to develop the dashboards UI locally. To get started:

Start Steampipe

  • 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

  • Navigate to the dashboard UI with cd ui/dashboard
  • Run yarn install
  • Run yarn start
  • The browser will open at http://localhost:3000
  • Any changes you make to the source code will be reflected in the dashboard UI in realtime

Component library

To browse the dashboard component library do the following:

  • cd ui/dashboard
  • yarn install
  • yarn storybook

Your default browser will open up the component library.

Adding new chart types

  • Navigate to ui/dashboard/src/components/dashboards/charts

  • Add a folder for the new chart type and add index.tsx

  • Ensure you call registerComponent before the export

  • Import this new chart in ui/dashboard/src/utils/registerComponents.ts

  • Add Storybook stories for your component in index.stories.js

  • Adding new flow types

  • Navigate to ui/dashboard/src/components/dashboards/flows

  • Add a folder for the new flow type and add index.tsx

  • Ensure you call registerComponent before the export

  • Import this new flow in ui/dashboard/src/utils/registerComponents.ts

  • Add Storybook stories for your component in index.stories.js

  • Adding new hierarchy types

  • Navigate to ui/dashboard/src/components/dashboards/hierarchies

  • 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

Reference in New Issue View Git Blame Copy Permalink