Building a Reactive Single-File Web App with Svelte

subaiyalShk — Sun, 10 Mar 2024 01:38:09 +0000

Step 1: ViteJS
Vite is a relatively new build tool and development server which provides an extremely fast and lean development experience. Here we will use ViteJS to quickly scaffold our Svelte project. To do so on you terminal run the command: npm create vite@latest

When the command is executed it will ask for project name so you can enter a name of your choice, then select Svelte when prompted to select a framework and lastly choose a variant. Here I have selected project name as test-project, framework as Svelte and variant as Javascript.

cd test-project
npm install
npm install @sveltejs/vite-plugin-svelte unocss vite-plugin-singlefile
npm run dev

The first command will navigate us into our new project then we install all the dependencies for this project. Next we will install 3 additional packages @sveltejs/vite-plugin-svelte, unocss and vite-plugin-singlefile.

1.@sveltejs/vite-plugin-svelte: is the official Vite plugin provided by the Svelte team. It integrates Svelte into the Vite build process, enabling us to compile Svelte components.

2.unocss: This library will help us significantly reduce the size and complexity of our stylesheet.

3.vite-plugin-singlefile: This plugin will enable the compilation of our entire project into a single HTML file.
making it super easy to distribute and share the project.

Next we need to configure our project to leverage the above plugins and library.

// vite.config.js
import { defineConfig } from 'vite';
import { svelte } from '@sveltejs/vite-plugin-svelte';
import UnoCSS from 'unocss/vite';
import { viteSingleFile } from 'vite-plugin-singlefile';

export default defineConfig(({ command }) => ({
    plugins: [
        UnoCSS(),
        svelte({
            /* plugin options */
        }),
        command === 'build' &&
            viteSingleFile({
                removeViteModuleLoader: true
            })
    ],
    build: {
        minify: true
    }
}));

Find the file called vite.config.js then place the above code in there. The defineConfig function is used customize our build and development process. Here, we’re adding our plugins to the Vite configuration and specifying that the vite-plugin-singlefile should only be used during the build process. This is achieved through the conditional statement command === 'build'. When we run the build command, this plugin will step in to compile our entire Svelte application into a single HTML file

The removeViteModuleLoader: true option within vite-plugin-singlefile configuration is particularly significant. This option strips away the Vite module loader from the final build, further simplifying our HTML file and ensuring that all our code is self-contained.

Lastly, we set minify to true. minification can reduce the file size, improve load times and make it difficult for malicious actors to read our code and find vulnerabilities.

Step 2: Building and Compiling Your Svelte Application

Once you have developed your Svelte application - including all your individual .svelte components - execute npm run build in the terminal. This will compile your entire application into a single self-contained HTML file.

This single HTML file is entirely self-contained, meaning it includes all of the HTML, CSS, and JavaScript needed to run your application. This makes it incredibly easy to share your project. You can distribute this single HTML file, and anyone can open it in their browser to run your application, without any additional setup or installation.

This ability to compile an entire Svelte project into a single, portable HTML file is a game-changer for sharing and deploying small-scale projects.

Forem: subaiyalShk

Building a Reactive Single-File Web App with Svelte