Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.39 KB

README.md

File metadata and controls

22 lines (14 loc) · 1.39 KB

svelte-map-app

screenshot

This is a simple templated mapping application, built using Svelte, SvelteKit, Node, Bulma, and Mapbox that can be easily customized using the fields in src/config/instance.json. It includes basic, but common, documentation pages, which can be written in markdown, and the map allows the user to select locations using click events or forward geocoding, which populate a bare-bones info panel.

Configuration

Node

Assuming you have node installed, you can install all dependencies by running npm install from the root directory.

MapBox Token

For the application to run, you'll need a MapBox token. The application expects it to be stored in a .env file in the root directory. E.g., this file should look like...

MAPBOX_TOKEN='your token here`

Important note: the token will be exposed to the client! As such, before deploying, you should make sure that your token is appropriately scoped and that it has URL restrictions in place.

Running

Run npm run css-build && npm run dev from the root folder. (On subsequent runs, you can simply run npm run dev. This starts a vite server (vite dev) and a node-sass watcher that watches for changes in src/styles/style.scss (the latter supports rapid Bulma development).