/test-upgraded-funicular

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Instructions

Pre-requisites

  1. Node.js 14
  2. yarn
  3. Grafana 7 (or docker and appropriate Grafana image)

Commands

  1. Run yarn command to install dependencies
  2. Run npm run build to build the plugin
  3. Launch Grafana and set up plugins path to the parent directory, e.g.
    docker run -d -p 3000:3000 -v "$(YOUR_PROJECT_PARENT_DIRECTORY)":/var/lib/grafana/plugins --name=grafana grafana/grafana:7.0.0

Now you can visit http://localhost:3000 (username: admin, password: admin) and add a new panel plugin to the dashboard. There are temporarily hardcoded API key and test request but no gifs will be displayed anyway. This is due to browser's 3rd party cookie restrictions, one can check them out in browser's devtools.

Grafana Panel Plugin Template

Build

This template is a starting point for building Grafana Panel Plugins in Grafana 7.0+

What is Grafana Panel Plugin?

Panels are the building blocks of Grafana. They allow you to visualize data in different ways. While Grafana has several types of panels already built-in, you can also build your own panel, to add support for other visualizations.

For more information about panels, refer to the documentation on Panels

Getting started

  1. Install dependencies

    yarn install
  2. Build plugin in development mode or run in watch mode

    yarn dev

    or

    yarn watch
  3. Build plugin in production mode

    yarn build

Learn more