Build lightning fast Progressive Web Apps with zero config and best practices built-in. Go from zero to production ready with Ionic and Stencil (Web Components).
Switch branches/tags
Nothing to show
Clone or download

readme.md

Ionic PWA Toolkit Beta

The PWA Toolkit is a starting point for building Progressive Web Apps using Ionic and Stencil. This combination of tools gives you the ability to build a fast, efficient PWA out of the box.

Note: This project is Beta and uses a beta release of @ionic/core.

For more info check out our homepage!

Features

  • @ionic/core for the UI.
  • Stencil for the application logic and routing
  • Push Notifications setup
  • Unit Tests
  • Pre-rendering
  • Lazy-loading and code splitting
  • Intelligent Polyfills
  • Modern mode: ES6/ESM for new browser, ES5 for older
  • Service Worker, App manifest, iOS meta tags
  • Theming using CSS variables

Getting Started

To start building, clone this repo to a new directory:

npm init stencil ionic-pwa

Production

To build for production, run:

npm run build

A production build includes:

  • Minified code bundles
  • Generated Service workers
  • App manifest

Hosting

Apps should be hosted on through HTTPS, and if possible, through a provider that supports HTTP2. One provider that does support this is Firebase Hosting.

H2 Push

We recommend setting up HTTP2 Push on Firebase. H2 Push may sound complicated, but it's actually a simple concept. To learn about it, take a look at this article.

To set this up for my-app:

  • Do a production build of the app: npm run build
  • Serve your WWW folder locally using a local http server and open in your browser.
  • Open the DevTools and look at the network tab.
    • Reload the page and you should see all of your files show up in the network tab. Excluding the sw.js file, these are the files you want to H2 push.
  • List these files in the link headers of your firebase.json file. For a syntax reference, review this article

Service Workers

Service workers are generated via the Stencil build tool. For more information on how they can be configured, see the Service Worker docs.

Developing with a Service Worker

For most cases, you'll want to develop your app without generating a Service Worker. But if you'd like to test out Web Push Notifications or Background Sync, you'll need to have one generated. To generate a Service Worker during dev builds, we've added the npm script:

npm run start.sw

This will start a dev build and generate a Service Worker as well.

Unit Tests

To run the unit tests once, run:

npm test

To run the unit tests and watch for file changes during development, run:

npm run test.watch

Testing your PWA's performance

We recommend using https://www.webpagetest.org/easy with the Run Lighthouse Audit option turned on. This will give you an in depth look into your app's load performance on the average device connected to the average network. For more info on how to use webpagetest check out this article