@quinnhornblow/svelte-maplibre

Purpose

A lightweight set of Svelte 5 MapLibre GL JS components to support other projects I'm working on.

Svelte library

Everything you need to build a Svelte library, powered by sv.

Read more about creating a library in the docs.

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

Building

To verify the library package:

npm run verify:package

To create a production version of your showcase app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish

To release a new version:

npm version [major/minor/patch]
git push
git push --tags

Then create a GitHub release for the new tag. The publish workflow runs tests and package verification before publishing to npm.