Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

113 lines (79 loc) · 2.49 KB
Raw

Building Map Plugin

Requirements

  • git
  • node v14+ and yarn

Install process

  • Clone "map-plugin" from repo to the grafana plugins folder. (eg. grafana_data/plugins)

  • Install plugin package dependencies

$ yarn install

If you are using Docker, the two steps above can be done as follows:

# First cd into this plugin's folder.
docker run -it --rm -v "$PWD":/usr/src/app -w /usr/src/app node:14 yarn install

Build process

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

    yarn dev

    or

    yarn dev --watch

  2. Build plugin in production mode

    yarn build

Test / Run

  1. Launch services

    docker compose -p map-panel up -d

  2. Import database

    sh populate_db.sh

  3. Set-up grafana

    sh set-up-grafana.sh

  4. In case of changes to code to restart grafana

    yarn dev && docker compose -p map-panel restart grafana

NOTE: Unless you remove the docker volumes, you need to run the last two steps above only the first time)

At this point in time login in grafana using admin/admin and you should be able to see a dashboard called Dashboard Map.

Other Tasks

  • Compile the code + restart grafana
$ yarn dev && docker compose -p map-panel restart grafana

Or using docker:

docker run -it --rm -v "$PWD":/usr/src/app -w /usr/src/app node:14 yarn build
docker-compose restart grafana

Releasing a new version

  1. Update the CHANGELOG.md document to include changes of the new release
  2. Tag the master with the new version: 
    git tag v1.4.0
git push origin v1.4.0
  3. Complete the release information in github.

Notes

Default start page url: http://localhost:3000 Default user/pass is admin/admin.

To display correctly TimscaleDB maps, you will have to insert manually the password (*) in the postgres data source

Learn more