JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 22
  • Score
    100M100P100Q56292F
  • License MIT

Local-first GPX routes viewer. Svelte-based components. Useable in Svelte projects and standalone (vanilla JS).

Package Exports

  • svelte-local-gpx-viewer

Readme

Svelte-local-gpx-viewer

A small collection of Svelte components to load GPX files (local first, persisted in browser's indexedDB) and display them.

data flow, src https://excalidraw.com/#json=J76wNr3qpoTNb7qClGL-3,EOjQwX2D0gBL2e85Cp84fw

Using the components in a Svelte/Sveltekit project

See Documentation website: https://0gust1.github.io/svelte-local-gpx-viewer/

Using the components in pure JS

TODO

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 which id used for the demo app.

Building

To build and package the library (Svelte version):

npm run package

To create a production version of the showcase app:

npm run build

You can them preview the showcase app build with npm run preview.

Vanilla JS

To create a vanilla JS version of the library:

npm run build && npm run build:vanilla

This will create a dist-js folder with the compiled library.

  • [] add an HTML file to the dist-js folder to test the integration of the library in a vanilla JS project.
  • [] add a README.md file to the dist-js folder to explain how to use the library in a vanilla JS project.

refs:

Publishing

To publish the library to npm:

npm publish