Svelte map using MapLibre GL JS

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

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

Screenshot

(back to top)

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

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

Demo

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

(back to top)

Build With

• Svelte
• MapLibre GL JS
• MapTiler

This project was generated with npx degit sveltejs/template my-svelte-project

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

(back to top)

Create an app

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

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

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

  cd my-svelte-map

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

  npm install

API KEY

Rename or copy the .env.example file to .env

  cp .env.example .env

Open the .env 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:

  npm run dev

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

Now you should see the app in your browser.

(back to top)

Build

To build for production, run:

  npm run build

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 svelte-maps.

Checkout to Get started with Svelte and MapLibre GL JS repo to use de svelte-maps component.