Everything you need to build a Svelte project, powered by create-svelte
.
If you're seeing this, you've probably already done this step. Congrats!
# create a new project in the current directory
npm create svelte@latest
# create a new project in my-app
npm create svelte@latest my-app
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
To create a production version of your 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.
PWA is set up using @vite-pwa/sveltekit
, which is part of vite-plugin-pwa
. It auto-generates the service worker.
The manifest is generated. The configuration is in vite.config.js
.
Normally, Sveltekit will register service-worker.js
automatically, if the file exists. The service worker has to be written manually. However, with the plugin, this is not necessary. The plugin will generate the Service Worker automatically, based on the project information.
Vite plugin PWA will create the service worker and the registration script. This is then applied in the +layout.svelte
, in the <body>
section.
The manifest needs to be included in the <head>
, so that the app can be installed.
Install "@vite-pwa/assets-generator".
To get the prompt in mobile browsers, add the items manually (see app.html). Adding them through svelte:head does not seem to work.
To run unit tests:
npm run test:unit
To run UI tests (Playwright):
npm run test:e2e