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

Template to create a new App plugin for @grafana.

License

Notifications You must be signed in to change notification settings

VolkovLabs/volkovlabs-abc-app

Repository files navigation

Template to create a new Grafana App plugin

App

Grafana CI E2E codecov CodeQL

Introduction

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

Generate an App template with https://github.com/VolkovLabs/volkovlabs-abc-app/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 a provisioned dashboard and App plugin.
  • 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 secure configuration for NGINX reverse proxy.

Support

License

Apache License Version 2.0, see LICENSE.