Skip to content

Releases: callmeahmedr/pwa-converter

v1.0

27 Aug 18:29
@callmeahmedr callmeahmedr
v1.0
8cc11b3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.0 Latest
Latest

Release Version: 1.0
Release Date: August 27, 2024

Overview

We are excited to announce the release of version 1.0 of the pwa-converter. This version introduces several key features aimed at enhancing the Progressive Web App (PWA) experience, including improved caching strategies, service worker updates, and a streamlined installation prompt. Below is a detailed list of the features included in this release.

Features

  1. Service Worker Installation and Activation

    • Caches essential assets during the service worker installation phase.
    • Cleans up old caches during activation to ensure the app uses the latest resources.

  2. Automatic Cache Update

    • Implements a periodic cache update mechanism that refreshes cached assets based on a defined interval (e.g., every week).
    • Ensures that users receive the latest version of assets without needing to manually clear the cache.

  3. Enhanced Fetch Handling

    • Serves cached assets when available and falls back to network requests if the asset is not cached.
    • Caches new network responses to keep the cache up-to-date with the latest content.

  4. Customizable Installation Prompt

    • Includes a visually appealing installation prompt button that encourages users to install the PWA.
    • Provides a custom install button with an icon and tooltip for better user engagement.

  5. Periodic Cache Update Notification

    • Periodically notifies users of available updates via the service worker, encouraging them to refresh the app for the latest features and improvements.

  6. Error Handling and Fallbacks

    • Implements error handling for fetch requests and provides a fallback response in case of network failures.

  7. Automatic Handling of Updates

    • Detects when a new version of the service worker is available and prompts users to refresh the app to get the latest updates.

Installation and Usage

  1. Service Worker Setup:

    • Ensure the service worker (service-worker.js) is in your domains root directory.
    • Make sure the folder pwa is also in your domains root directory.
    • MAKE SURE TO ADD <script src="/pwa/pwa.js"></script> IN FOOTER OF YOUR WEBSITE

  2. Update Intervals:

    • The cache update interval can be adjusted in service-worker.js by modifying the CACHE_UPDATE_INTERVAL constant.

  3. Installation Prompt Customization:

    • Customize the install button icon and tooltip in pwa/pwa.js to match your app’s branding.

For more details on how to integrate and configure these features, please refer to the documentation provided in the repository.

Thank you for using pwa-converter! We look forward to your feedback and contributions to future releases.

Author: Muhammad Ahmed
Open Source Project: pwa-converter on GitHub

Assets 2
Loading