Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

Latest commit

 

History

History
74 lines (47 loc) · 2.51 KB

README.md

File metadata and controls

74 lines (47 loc) · 2.51 KB
Raw

Template to create a new Grafana panel plugin

Dashboard

Grafana 10 CI E2E codecov CodeQL

Introduction

The Abc panel is a template we created to streamline our development process and gladly share it with the Grafana community.

To make the creation process efficient, starting with a well-constructed template is always easier.

Generate a template with https://github.com/VolkovLabs/volkovlabs-abc-panel/generate.

Requirements

  • Version 3.X requires Grafana 9 or Grafana 10.
  • Version 2.X requires Grafana 8.5 or Grafana 9.
  • Version 1.X requires Grafana 8.

Getting Started

  1. Install packages
npm install
  1. Build the plugin
npm run build
  1. Sign the plugins if required
export GRAFANA_ACCESS_POLICY_TOKEN=token==
npm run sign
  1. Start the Docker container
npm run start

Highlights

  • Use docker-compose to start the development environment with provisioned data source and dashboard.
  • Provides unit and E2E test configuration.
  • Based on the latest version of Grafana and Grafana Tools.
  • Includes GitHub Actions for CI, E2E and Release.
  • Includes Static Data Source to emulate any data.

Tutorial

Follow along and have your first-panel plugin built and provisioned. We created this three-part series as an easy-to-follow tutorial.

Build a panel plugin, part 1 | Grafana Crash Course for Developers

Support

License

Apache License Version 2.0, see LICENSE.