koalalorenzo/dashboard-framework
1
1
Fork 0
mirror of https://github.com/LEGO/dashboard-framework.git synced 2026-06-16 04:36:54 +00:00
Code Issues Projects Releases Packages Wiki Activity
Create Grafana Dashboards by focusing on What telemetry data is important, what platforms and what tools you use.
79 commits 4 branches 3 tags 395 KiB
  • TypeScript 82.8%
  • CSS 15%
  • Nix 1.3%
  • Dockerfile 0.6%
  • HTML 0.3%
Find a file
Exact
Lorenzo Setale 09bd76f634
 docs: update readme with bulletpoints and updates keys and routine updates (#34) 
* chore: update dependencies from nix

Signed-off-by: Lorenzo Setale <lorenzo.setale@LEGO.com>

* chore: updates encrcyption keys and rotate values

Signed-off-by: Lorenzo Setale <lorenzo.setale@LEGO.com>

* docs: enrich the readme with bulletpoints

Signed-off-by: Lorenzo Setale <lorenzo.setale@LEGO.com>

---------

Signed-off-by: Lorenzo Setale <lorenzo.setale@LEGO.com>
2026-05-01 10:29:18 +02:00
.github feat: adds workflows to handle issues, PRs and to welcome new contributors. (#31) 2026-04-16 10:35:28 +02:00
docs feat(features): Adds icons next to the feature selection (#21) 2026-04-14 09:59:35 +02:00
src feat: Valkey feature from edge (#33) 2026-04-20 09:58:40 +02:00
.envrc feat: automatic upload when pushing to main to s3.elates.it 2026-01-14 18:21:29 +01:00
.gitignore feat(server): adds Containerfile to run standalone with potential proxies 2026-03-23 10:59:50 +01:00
.sops.env docs: update readme with bulletpoints and updates keys and routine updates (#34) 2026-05-01 10:29:18 +02:00
.sops.yaml docs: update readme with bulletpoints and updates keys and routine updates (#34) 2026-05-01 10:29:18 +02:00
bun-env.d.ts import from backups 2026-01-09 00:50:18 +01:00
bun.lock feat(features): Adds icons next to the feature selection (#21) 2026-04-14 09:59:35 +02:00
bunfig.toml feat(auth): makes SSO portable via env variables (#15) 2026-04-07 14:36:42 +02:00
CODE_OF_CONDUCT.md docs: adds code of conduct \o/ (#23) 2026-04-14 10:47:16 +02:00
CODEOWNERS chore: setup template, contributing guidelines, codeowners etc etc (#9) 2026-03-31 12:50:47 +02:00
Containerfile feat(server): adds Containerfile to run standalone with potential proxies 2026-03-23 10:59:50 +01:00
CONTRIBUTING.md chore: setup template, contributing guidelines, codeowners etc etc (#9) 2026-03-31 12:50:47 +02:00
flake.lock docs: update readme with bulletpoints and updates keys and routine updates (#34) 2026-05-01 10:29:18 +02:00
flake.nix docs: how to add a new feature (#18) 2026-04-13 12:47:21 +02:00
LICENSE chore: OSS Release prep (#1) 2026-03-23 17:27:01 +01:00
package.json feat(features): Adds icons next to the feature selection (#21) 2026-04-14 09:59:35 +02:00
README.md docs: update readme with bulletpoints and updates keys and routine updates (#34) 2026-05-01 10:29:18 +02:00
tsconfig.json import from backups 2026-01-09 00:50:18 +01:00

README.md

Dashboard Framework

Dashboard Framework helps creating intuitive, and valuable Grafana Dashboards by asking simple questions and by focusing on what telemetry data would be more useful to show, rather than how to structure it.

It is designed to help Platform Engineers and Platform Users generate production-ready dashboards with the following capabilities:

  • Highly customizable: Platform Engineers and Platform Users can select only the features they need
  • Supports data from multiple platforms in the same dashboard
  • Exposes application custom metrics and logs for Developers
  • Makes it easier for Platform Engineers and Platform Users to identify issues across dependencies and platforms.

Note

This project is currently developed for internal use, but may later be developed for broader consumption

Usage

To run the project locally you need Nix installed and available. It will install and prepare all the dependencies needed. We run and test the project on macOS and GNU/Linux.

To access the development shell run:

nix develop

After that you can install the node_modules and start the server:

bun install

bun run dev

You can then open a browser to localhost:3000 and use the dashboard framework while working on it.

Contributing

Contributions are more than welcome. By sending PRs (pull request), you agree to license your work under the same license as this repository. Please read and get familiar with the contributing guidelines before opening a PR.

As this project is in the early stages of development, we are still working on the contribution guidelines and best practices. We appreciate your patience and understanding as we work to improve the project.

License

This project is under the MIT License. See the LICENSE.