Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 1.49 KB

README.md

File metadata and controls

73 lines (47 loc) · 1.49 KB
Raw

Grafana App with Dashboards Plugin example

This template is a starting point for building an app plugin for Grafana. It includes a dashboard.

What are Grafana app plugins?

App plugins can let you create a custom out-of-the-box monitoring experience by custom pages, nested datas ources, and panel plugins.

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 (using Playwright)

    # 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.