Svelte + Vite
This template should help get you started developing with Svelte in Vite.
How to Get Started
Prerequisites
- Node.js (v16 or higher recommended)
- npm (comes with Node.js)
Installation
- Clone or download this repository
- Install dependencies:
npm install
Running the Application
Development Mode (Web)
To run the Svelte app in development mode with hot module replacement:
npm run dev
This will start the Vite development server at http://localhost:5173
Development Mode (Electron)
To run the Electron app in development mode:
npm run electron:dev
This will:
- Start the Vite development server
- Launch the Electron app once the server is ready
- Enable hot module replacement for both the web app and Electron
Building for Production
To build the application for production:
npm run build
This creates an optimized production build in the dist directory.
Building Electron App
To build a distributable Electron app:
npm run electron:build
This will build the web app and create an Electron installer in the release directory.
To create an unpacked build (for testing):
npm run electron:pack
Recommended IDE Setup
Need an official Svelte framework?
Check out SvelteKit, which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
Technical considerations
Why use this over SvelteKit?
- It brings its own routing solution which might not be preferable for some users.
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other create-vite templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
Why include .vscode/extensions.json?
Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
Why enable checkJs in the JS template?
It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.
Why is HMR not preserving my local component state?
HMR state preservation comes with a number of gotchas! It has been disabled by default in both svelte-hmr and @sveltejs/vite-plugin-svelte due to its often surprising behavior. You can read the details here.
If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
// store.js
// An extremely simple external store
import { writable } from 'svelte/store'
export default writable(0)
