maptiler / angular-template-maplibre-gl-js

A quick way to start a web map application with Angular using MapLibre GL JS

MapLibre GL JS map using Angular

A quick way to start a web map application with Angular using MapLibre GL JS.

A simple fullscreen map application is used to showcase how to utilize MapTiler maps together with Angular and MapLibre GL JS for your Angular app.

Screenshot

(back to top)

Step-by-step tutorial - How to display a map in Angular using MapLibre GL JS

Documentation: How to display a map in Angular using MapLibre GL JS

Demo

Online demo: https://labs.maptiler.com/angular-template-maplibre-gl-js/

(back to top)

Build With

• Angular
• MapLibre GL JS
• MapTiler

This project was generated with Angular CLI version 13.0.2.

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• Angular CLI

  npm install -g @angular/cli

(back to top)

Create an app

Clone the repo to create a new angular project. Run in your command-line:

  git clone https://github.com/maptiler/angular-template-maplibre-gl-js.git my-angular-map

Navigate to the newly created project folder my-angular-map

Install the NPM packages dependencies. Run in your command-line:

  npm install

API KEY

Navigate to the src/environments folder

Open the environment.ts and environment.prod.ts file, ⚠️ you will need to replace YOUR_MAPTILER_API_KEY with your own MapTiler API key.

Your MapTiler account access key is on your MapTiler Cloud account page.

ℹ️ If you don't have an API KEY, you can create it for free at https://www.maptiler.com/cloud/

Run

To start your local environment, run:

  ng serve --open

You will find your app on address http://localhost:4200/.

Now you should see the app in your browser.

(back to top)

Build

To build for production, run:

  ng build --base-href /angular-template-maplibre-gl-js/

gh-pages

To deploy the app to the gh-pages branch, run:

  node gh-pages.js

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

Instead of using or developing a custom map component, you can use the Angular binding of maplibre-gl-js (ngx-maplibre-gl).

Checkout to Get started with Angular and MapLibre GL JS repo to use de ngx-maplibre-gl component.

angular-template-maplibre-gl-js's Issues

maplibre-gl-js not working with Angular 16

Following the guide at https://docs.maptiler.com/angular/maplibre-gl-js/how-to-use-maplibre-gl-js/ with Angular version 16, or updating this repo to Angular 16, results in the following error:

Error: node_modules/maplibre-gl/dist/maplibre-gl.d.ts:5701:21 - error TS2503: Cannot find namespace 'NodeJS'. 5701 _updateHash: () => NodeJS.Timeout;

This issue is reproducible

Environment Details:

• Node version: v18.16.1
• Angular version: 16.1.4

How would I add clustering to this example?

I am trying to add this example https://maplibre.org/maplibre-gl-js-docs/example/cluster/ but struggling with it. Is it possible to provide an example?