d-dash

Contract-first embeddable dashboard engine with a headless core and pluggable adapters for datasources, visualizations, and grid/layout runtimes.

Highlights

• Headless runtime (@d-dash/core) with typed contracts
• First-party adapters for ECharts, Gridstack, REST, VictoriaMetrics, and gRPC
• Persisted JSON schema separated from runtime-resolved execution model
• Structured error model and adapter capability declarations

Packages

• @d-dash/core
• @d-dash/adapter-echarts
• @d-dash/adapter-gridstack
• @d-dash/datasource-rest
• @d-dash/datasource-victoriametrics
• @d-dash/datasource-grpc

Quick start

npm install
npm run build
npm run test

Run the basic browser example:

npm run -w examples/basic dev

Documentation

• Architecture
• Contracts
• Schema design
• Usage
• Plugin development
• Code rules
• Docs index

API docs

Generate API docs from JSDoc + TypeDoc:

npm run docs:api

Output is written to docs/api.

Release readiness

npm run release:prepare
npm run release:dry-run
npm run release:publish

GitHub Actions:

• CI runs release:prepare on push and pull requests.
• Publish Packages supports manual dry-run and publish via workflow dispatch.

Detailed maintainer steps are documented in docs/RELEASE.md.

Contributing

See CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md.