Name		Name	Last commit message	Last commit date
parent directory ..
.config		.config
provisioning/plugins		provisioning/plugins
src		src
tests		tests
.cprc.json		.cprc.json
.eslintrc		.eslintrc
.gitignore		.gitignore
.nvmrc		.nvmrc
.prettierrc.js		.prettierrc.js
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
docker-compose.yaml		docker-compose.yaml
jest-setup.js		jest-setup.js
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
playwright.config.ts		playwright.config.ts
tsconfig.json		tsconfig.json

README.md

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

Install dependencies
```
npm install
```
Build plugin in development mode or run in watch mode
```
npm run dev
```
Build plugin in production mode
```
npm run build
```

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

Spin up a Grafana instance and run the plugin inside it (using Docker)
```
npm run server
```

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

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.