https://github.com/dhis2/maps-gl
WebGL/vector tiles engine for DHIS2 Maps
https://github.com/dhis2/maps-gl
synced-settings web-lib
Last synced: 27 days ago
JSON representation
WebGL/vector tiles engine for DHIS2 Maps
- Host: GitHub
- URL: https://github.com/dhis2/maps-gl
- Owner: dhis2
- License: bsd-2-clause
- Created: 2019-01-22T10:01:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-18T08:50:53.000Z (3 months ago)
- Last Synced: 2025-04-17T10:24:40.866Z (about 1 month ago)
- Topics: synced-settings, web-lib
- Language: JavaScript
- Size: 11.2 MB
- Stars: 2
- Watchers: 24
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# maps-gl
[](https://github.com/dhis2/maps-gl/actions?query=workflow%3A%22DHIS2+Build+and+Release%22)
WebGL mapping engine for DHIS2 Maps
## Link to DHIS2 Maps:
maps-gl folder: `yarn link`
maps-app folder: `yarn link @dhis2/maps-gl`
## How to upgrade earthengine-api
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
## Build from source
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.
## Publishing
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](https://www.conventionalcommits.org/en/v1.0.0/) guidelines so that the release bot can determine which version to cut - breaking, feature, or bug
## Publishing pre-release versions during app development
Builds for all non-production branches are automatically copied to [d2-ci/maps-gl](https://github.com/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",
...
}
```
## Report an issue
The issue tracker can be found in [DHIS2 JIRA](https://jira.dhis2.org)
under the [LIBS](https://jira.dhis2.org/projects/LIBS) project.
Deep links:
- [Bug](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10006&components=11028)
- [Feature](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10300&components=11028)
- [Task](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10003&components=11028)