svelte-maplibre-boilerplate

Everything you need to build a Svelte project, powered by create-svelte.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm init svelte

# create a new project in my-app
npm init svelte my-app

Environmental variables

cp .env.example
vi .env

Add your own API key VITE_MAPTILER_KEY for maptiler. The key can be created at maptiler website here. You probably need to sign up first.

Furthermore, edit config.ts for your environment.

Developing

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

pnpm dev

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

open http://localhost:3000.

The path of URL can be changed at svelte.config.js.

Lefthook

When you clone the repository from Github for the first time, please install lefthook in your local machine manually by following commands. So, lint, format and build command will be automatically executed when you commit or push.

pnpm lefthook install

Building

To create a production version of your app:

pnpm build

You can preview the production build with pnpm preview.

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