A WebGL rendering engine for DHIS2 maps based on Mapbox GL JS.
npm install @dhis2/maps-gl
WebGL mapping engine for DHIS2 Maps
maps-gl folder: yarn link
maps-app folder: yarn link @dhis2/maps-gl
We run earthengine-api in a web worker for performance reasons, and this requires a separate build:
1. git clone https://github.com/MasterMaps/earthengine-api/tree/master (make sure the fork is synced)
2. git chekout master
3. git pull
4. git checkout web-worker-build
5. git merge master
6. cd javascript
7. yarn build
8. copy the contents of javascript/build/worker.js to ee_api_js_worker in this repo
PR to main earthengine-api repo: https://github.com/google/earthengine-api/pull/173
In order to use the library you must first build it from source using the command yarn build
You may also watch the src directory for changes with the command yarn watch
Both of these commands will run the javascript files in the src directory through babel to produce both CommonJS and ES Module builds in the build directory.
Publication is done automatically by a GitHub action for all commits on the master branch. Commits (including pull-request squashed commits) should follow the Conventional Commit guidelines so that the release bot can determine which version to cut - breaking, feature, or bug
Builds for all non-production branches are automatically copied to d2-ci/maps-gl for use during development and testing, prior to production release.
To test changes in a development branch, change the maps-gl dependency of package.json of the app you are testing with. There are a few options:
1. point to a specific commit:
``
"dependencies": {
"@dhis2/maps-gl": "git+https://github.com/d2-ci/maps-gl.git#70249ebe8be39051fa10142f850de449e1ec488c",
...
}
2. point to a branch:
`
"dependencies": {
"@dhis2/maps-gl": "git+https://github.com/d2-ci/maps-gl.git#chore/some-chore",
...
}
The issue tracker can be found in DHIS2 JIRA
under the LIBS project.
Deep links: