kalisio/kApp

View on GitHub
docs/guides/customizing/pwa.md

Summary

Maintainability
Test Coverage
# PWA

The kApp is a **Progressive Web App (PWA)**, which means it functions as both a web page and a mobile app, offering a versatile experience on any device.

::: tip
To build and run the **kApp** as a PWA, check out the main commands [here](https://kalisio.github.io/skeleton/guides/development/develop.html)
:::

## Configuration

### Web app manifest

A web app manifest provides essential information about the application, such as its name, author, icon, and description, in a JSON text document. The purpose of the manifest is to allow the installation of applications on a device's home screen. You can find this manifest in the [Quasar configuration](https://github.com/kalisio/kApp/blob/master/quasar.config.js#L250).

### Service Worker 

[Service workers](https://github.com/kalisio/kApp/blob/master/src-pwa/custom-service-worker.js), which operate as JavaScript events, are a core component of a PWA and act as a proxy. They enable fast loading, offline access, push notifications, and other capabilities. 

<img src="../../.vitepress/public/images/service-worker.svg" style="margin-left: auto; margin-right: auto;">

::: tip
When the application is ready to be installed or updated, a pop-up window will appear.
:::

### Push notfication

KApp provides an [example](https://kapp.dev.kalisio.xyz/#/home/webpush) of how to implement push notifications using the [feathers-webpush module](https://github.com/kalisio/feathers-webpush).