Skip to content

DEVELOPMENT_GUIDE.md

Latest commit

 

History

History
55 lines (36 loc) · 1.32 KB

DEVELOPMENT_GUIDE.md

File metadata and controls

55 lines (36 loc) · 1.32 KB

Development guide

This plugin uses @grafana/create-plugin.

Below are just some very basic steps to get starting with the development environment, but there is a guide of how to setup the development environment from Grafana: https://grafana.com/developers/plugin-tools/get-started/set-up-development-environment.

  1. Install dependencies

    pnpm install

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

    pnpm run dev

  3. Start the Grafana dev server on http://localhost:3000:

    pnpm run server

    The base image and version can be configured with the GRAFANA_IMAGE and GRAFANA_VERSION environment variables:

    GRAFANA_IMAGE=grafana GRAFANA_VERSION=12.0.1 pnpm run server
GRAFANA_IMAGE=grafana GRAFANA_VERSION=8.2.0 pnpm run server
GRAFANA_IMAGE=grafana-enterprise GRAFANA_VERSION=11.5.3 pnpm run server

Website

The website is built with Docusaurus. To run the website locally, you can use the following commands:

  1. Go to the website directory:

    cd website

  2. Install dependencies:

    pnpm install

  3. Start the website in development mode:

    pnpm start

Most of the website content is in the website/docs directory.