README.md

Grafana Panel Plugin with Datalinks example

This template is a starting point for building a panel plugin with data links for Grafana.

What are Grafana panel plugins?

Panel plugins allow you to add new types of visualizations to your dashboard, such as maps, clocks, pie charts, lists, and more.

Use panel plugins when you want to do things like visualize data returned by data source queries, navigate between dashboards, or control external systems (such as smart home devices).

Get started

Frontend

1. Install dependencies:

   npm install

2. Build plugin in development mode or run in watch mode:

   npm run dev

3. Build plugin in production mode:

   npm run build

4. Run the tests (using Jest):

   # Runs the tests and watches for changes
   npm run test
   
   # Exists after running all the tests
   npm run lint:ci

5. Spin up a Grafana instance and run the plugin inside it (using Docker):

   npm run server

6. Run the E2E tests:

   # Spin up a Grafana instance first that we tests against
   npm run server
   
   # Start the tests
   npm run e2e

7. Run the linter:

   npm run lint
   
   # or
   
   npm run lint:fix

Learn more

Below you can find source code for existing app plugins and other related documentation.

• Basic panel plugin example
• Plugin.json documentation
• Sign a plugin