You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
vargburz af5e5ab4c6 subscrine && modal and new table UI 2 years ago
.config copy panel from the panel repo 2 years ago
cypress/integration grafana app boilerplate 2 years ago
src subscrine && modal and new table UI 2 years ago
.eslintrc grafana app boilerplate 2 years ago
.gitignore config page (#1) 2 years ago
.nvmrc grafana app boilerplate 2 years ago
.prettierrc.js grafana app boilerplate 2 years ago
CHANGELOG.md grafana app boilerplate 2 years ago
LICENSE grafana app boilerplate 2 years ago
README.md grafana app boilerplate 2 years ago
docker-compose.yaml grafana app boilerplate 2 years ago
jest.config.js grafana app boilerplate 2 years ago
package.json config page (#1) 2 years ago
tsconfig.json grafana app boilerplate 2 years ago
webpack.config.ts config page (#1) 2 years ago
yarn.lock config page (#1) 2 years ago

README.md

Grafana app plugin template

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

What are Grafana app plugins?

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

Getting started

Frontend

  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
    
  4. Run the tests (using Jest)

    # Runs the tests and watches for changes
    yarn test
    
    # Exists after running all the tests
    yarn lint:ci
    
  5. Spin up a Grafana instance and run the plugin inside it (using Docker)

    yarn server
    
  6. Run the E2E tests (using Cypress)

    # Spin up a Grafana instance first that we tests against 
    yarn server
    
    # Start the tests
    yarn e2e
    
  7. Run the linter

    yarn lint
    
    # or
    
    yarn lint:fix
    

Learn more

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