forked from grafana/worldmap-panel
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
33 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,28 @@ | ||
# Building the Grafana Map Panel | ||
# Hacking on the Grafana Map Panel | ||
|
||
## Introduction | ||
The easiest way to get started is to git clone the project repository | ||
directly into the `data/plugins` of your Grafana instance followed | ||
by building it there. | ||
|
||
1. Install npm packages: `npx yarn install` | ||
2. Build and lint the JavaScript: `npx yarn build` | ||
2. Run the tests before submitting a PR: `npx yarn test` | ||
3. A test watcher when TDD:ing: `npx yarn dev --watch` | ||
|
||
Grafana will read in the `dist` folder first so to see your changes in | ||
Grafana will read in the `dist` folder first. So, to see your changes in | ||
Grafana, you will have to build the plugin once. However, you do not | ||
need to restart your local Grafana server after every change, just | ||
refreshing the page will be sufficient. | ||
|
||
For packaging this plugin, invoke:: | ||
## General | ||
1. Display all tasks from `grafana-toolkit`: `npx grafana-toolkit --help` | ||
|
||
npx grafana-toolkit plugin:ci-package | ||
## Development | ||
1. Install packages: `npx yarn install` | ||
2. Bundle plugin in dev mode: `npx yarn dev` | ||
3. Bundle plugin in dev mode and start a watcher: `npx yarn watch` | ||
4. Run the tests before submitting a PR: `npx yarn test` | ||
|
||
When this process succeeds, packages can be found within the `ci/packages/` folder. | ||
|
||
# Building the Grafana Map Panel | ||
1. Install packages: `npx yarn install` | ||
2. Build into `dist/`, lint and run tests: `npx yarn build` | ||
3. Build plugin on CI: `npx grafana-toolkit plugin:ci-build` | ||
4. Create a zip package: `npx grafana-toolkit plugin:ci-package` | ||
When this process succeeds, packages can be found within the `ci/packages/` folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters