Stencil

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

Example #

System Requirements #

• Install Node.js 16.16.0

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.

1npm i -g @edgio/cli

Create a new Stencil app #

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

1npm init stencil

1? Pick a starter › - Use arrow-keys. Return to submit.
2
3   component     Collection of web components that can be used anywhere
4 ❯ app           Minimal starter for building a Stencil app or website

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

1npm install && npm run start

Configuring your Stencil app for Edgio #

Initialize your project #

In the root directory of your project run edgio init:

1edgio init

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

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

Configure the routes #

Update routes.js at the root of your project to the following:

1// This file was added by edgio init.
2// You should commit this file to source control.
3
4import { Router } from '@edgio/core/router'
5
6export default new Router()
7  // Create serveStatic route for each file in the folder www with a cache-control header of 's-maxage=315360000'
8  .static('www')
9  .fallback(({ appShell }) => {
10    appShell('www/index.html')
11  })

Refer to the CDN-as-code guide for the full syntax of the routes.js file and how to configure it for your use case.

Run the Stencil app locally on Edgio #

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

1npm run build

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

1edgio 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:

1npm run build

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

1edgio deploy

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