{"id":22547530,"url":"https://github.com/sjcobb/perses-embed-example","last_synced_at":"2025-08-27T14:16:52.648Z","repository":{"id":86465723,"uuid":"581373043","full_name":"sjcobb/perses-embed-example","owner":"sjcobb","description":"Perses embeddable dashboard \u0026 visualization framework example app (built with MUI + Next.js)","archived":false,"fork":false,"pushed_at":"2023-01-12T15:14:11.000Z","size":2388,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T09:11:42.382Z","etag":null,"topics":["charting-library","dashboards","data-visualization","echarts","mui","perses","prometheus"],"latest_commit_sha":null,"homepage":"https://perses-embed-example.vercel.app/dashboard","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sjcobb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-23T02:08:13.000Z","updated_at":"2023-03-11T03:44:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"7f77a779-01ee-4f74-9f71-790a325a1dbd","html_url":"https://github.com/sjcobb/perses-embed-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sjcobb/perses-embed-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjcobb%2Fperses-embed-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjcobb%2Fperses-embed-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjcobb%2Fperses-embed-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjcobb%2Fperses-embed-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sjcobb","download_url":"https://codeload.github.com/sjcobb/perses-embed-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sjcobb%2Fperses-embed-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272339509,"owners_count":24917184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-27T02:00:09.397Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["charting-library","dashboards","data-visualization","echarts","mui","perses","prometheus"],"created_at":"2024-12-07T15:12:16.338Z","updated_at":"2025-08-27T14:16:52.599Z","avatar_url":"https://github.com/sjcobb.png","language":"TypeScript","readme":"# Perses Embed Example Application\n\nDemo of [Perses](https://github.com/perses/perses) embedded dashboard and components functionality. See pages:\n\n- https://perses-embed-example.vercel.app/dashboard\n  - [sample dashboard](https://github.com/sjcobb/perses-embed-example/blob/custom-panel-plugin-scatter-init/data/dashboard-sample.ts) with core panel types (TimeSeriesChart, GaugeChart, StatChart) and custom panel plugin examples\n- https://perses-embed-example.vercel.app/demo\n  - custom chart component examples\n\n## Getting Started\n\nTo embed Perses dashboards, panels, and components, use the following steps:\n\n- install @mui/material, @fontsource/lato\n  - https://mui.com/material-ui/getting-started/installation/\n- install Perses packages\n  - npm i @perses-dev/components @perses-dev/core @perses-dev/dashboards @perses-dev/panels-plugin @perses-dev/plugin-system @perses-dev/prometheus-plugin\n  - Note: CSS errors will be fixed as part of: https://github.com/perses/perses/issues/894\n  - see next.config.js `transpilePackages` to fix lodash-es, echarts ES module errors\n- add Perses Providers: ChartsThemeProvider, QueryClientProvider, QueryParamProvider, PluginRegistry\n- customize MUI theme (see [createTheme](https://github.com/sjcobb/perses-embed-example/blob/main/pages/_app.tsx))\n- [register custom plugins](https://github.com/sjcobb/perses-embed-example/blob/main/components/dashboards/plugins/plugin.json) (see [PluginLoader](https://github.com/sjcobb/perses-embed-example/blob/main/components/dashboards/PersesPluginRegistry.tsx))\n- customize [ECHARTS_THEME_OVERRIDES](https://github.com/sjcobb/perses-embed-example/blob/main/components/dashboards/PersesDashboardProviders.tsx)\n  - see ECharts [theme builder](https://echarts.apache.org/en/theme-builder.html), supported [option properties](https://echarts.apache.org/en/option.html#series-line.type)\n\n## Plugin System\n\nCustom plugin examples:\n\n- [Scatterplot](https://github.com/sjcobb/perses-embed-example/tree/main/components/dashboards/plugins/scatterplot) panel plugin\n- [Image generation](https://github.com/sjcobb/perses-embed-example/tree/main/components/dashboards/plugins/generate-image-canvas) panel plugin (save image URLs from Replicate API)\n- Image query plugin (Stable Diffusion)\n\n## Components Demo\n\nSee available components in @perses-dev/components [README](https://github.com/perses/perses/blob/main/ui/components/README.md) (Storybook support coming soon)\n\nNote: The Perses LineChart.tsx component uses ECharts, but has a custom tooltip for improved performance. To use this component, a [ChartsThemeProvider](https://github.com/sjcobb/perses-embed-example/blob/main/pages/demo.tsx) must also be used (Or else `Error: No ChartsThemeContext found. Did you forget a Provider?` will be thrown).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsjcobb%2Fperses-embed-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsjcobb%2Fperses-embed-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsjcobb%2Fperses-embed-example/lists"}