Edgio
Edgio

Svelte

This guide shows you how to deploy a Svelte application to Edgio.

Example

System Requirements

Sign up for Edgio

Deploying requires an account on Edgio. Sign up here for free.

Install the Edgio CLI

If you have not already done so, install the Edgio CLI.

With npm:

Bash
1npm i -g @layer0/cli

With yarn:

Bash
1yarn global add @layer0/cli

Create a new Svelte app

If you don’t already have a Svelte app, create one by running the following:

Bash
1npx degit sveltejs/template-webpack svelte-app
2cd svelte-app
3npm install

You can verify your app works by running it locally with:

Bash
1npm run dev

Configuring your Svelte app for Edgio

Initialize your project

In the root directory of your project run 0 init:

Bash
10 init

This will automatically update your package.json and add all of the required Edgio dependencies and files to your project. These include:

  • The @layer0/core package - Allows you to declare routes and deploy your application on Edgio
  • The @layer0/prefetch package - Allows you to configure a service worker to prefetch and cache pages to improve browsing speed
  • layer0.config.js - A configuration file for Edgio
  • routes.js - A default routes file that sends all requests to Svelte.

Adding Edgio Service Worker

To add service worker to your Svelte app, run the following in the root folder of your project:

Bash
1npm i process register-service-worker workbox-webpack-plugin

Create service-worker.js at the root of your project with the following:

JavaScript
1import { skipWaiting, clientsClaim } from 'workbox-core'
2import { precacheAndRoute } from 'workbox-precaching'
3import { Prefetcher } from '@layer0/prefetch/sw'
4
5skipWaiting()
6clientsClaim()
7precacheAndRoute(self.__WB_MANIFEST || [])
8
9new Prefetcher().route()

To register the service worker, first create registerServiceWorker.js in the src folder:

JavaScript
1/* eslint-disable no-console */
2
3import { register } from 'register-service-worker'
4
5if (process.env.NODE_ENV === 'production') {
6 register(`/service-worker.js`, {
7 ready() {
8 console.log(
9 'App is being served from cache by a service worker.\n' +
10 'For more details, visit https://goo.gl/AFskqB',
11 )
12 },
13 registered() {
14 console.log('Service worker has been registered.')
15 },
16 cached() {
17 console.log('Content has been cached for offline use.')
18 },
19 updatefound() {
20 console.log('New content is downloading.')
21 },
22 updated() {
23 console.log('New content is available; please refresh.')
24 },
25 offline() {
26 console.log('No internet connection found. App is running in offline mode.')
27 },
28 error(error) {
29 console.error('Error during service worker registration:', error)
30 },
31 })
32}

and to include the service worker in the app, edit main.js (in the src folder) as follows:

JavaScript
1import './global.css'
2import App from './App.svelte'
3+ import './registerServiceWorker'
4
5const app = new App({
6 target: document.body,
7 props: {
8 name: 'world',
9 },
10})
11
12export default app

Now, in webpack.config.js make the following additions:

JavaScript
1+ const { InjectManifest } = require("workbox-webpack-plugin");
2+ const webpack = require('webpack')
3
4 plugins: [
5 + new webpack.ProvidePlugin({
6 + process: 'process/browser',
7 + }),
8 + new InjectManifest({
9 + swSrc: "./service-worker.js",
10 + })
11 ]

Configure the routes

Next you’ll need to configure Edgio routing in the routes.js file. Replace the routes.js file that was created during 0 init with the following:

JavaScript
1const { Router } = require('@layer0/core/router')
2
3module.exports = new Router()
4 // Prevent search engine bot(s) from indexing
5 // Read more on: https://docs.layer0.co/guides/cookbook#blocking-search-engine-crawlers
6 .noIndexPermalink()
7
8 // Send requests to static assets in the build output folder `public`
9 .static('public')
10
11 // Send everything else to the App Shell
12 .fallback(({ appShell }) => {
13 appShell('public/index.html')
14 })

The example above assumes you’re using Svelte as a single page app. It routes the static assets (JavaScript, CSS, and Images) in the production build folder public and maps all other requests to the app shell in public/index.html.

Refer to the Routing guide for the full syntax of the routes.js file and how to configure it for your use case.

Run the Svelte app locally on Edgio

Create a production build of your app by running the following in your project’s root directory:

Bash
1npm run build

Test your app with the App Platform on your local machine by running the following command in your project’s root directory:

Bash
1npm run dev

Load the site http://127.0.0.1:3000

Deploying

Create a production build of your app by running the following in your project’s root directory:

Bash
1npm run build

Deploy your app to the App Platform by running the following command in your project’s root directory:

Bash
10 deploy

Refer to the Deploying guide for more information on the deploy command and its options.