Skip to content

cjpatoilo/pwa-installer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

df53123 · Aug 1, 2020

History

22 Commits
Aug 1, 2020
Oct 23, 2019
Oct 23, 2019
Aug 1, 2020
Aug 1, 2020
Feb 21, 2018
Aug 1, 2020
Aug 1, 2020
Oct 23, 2019
Aug 1, 2020
Aug 1, 2020
Aug 1, 2020
Aug 1, 2020
Aug 1, 2020

Repository files navigation

PWA Installer - Zero-configuration for installing PWA features.

Zero-configuration for installing PWA features.

Travis Status AppVeyor Status Codacy Status Dependencies Status Version Status Download Status Gitter Chat

Why it's awesome

Zero-configuration for installing PWA features. Although sw-precache works great as a light-weight tool to quickly install service worker support, it currently does not provide much functionality for installing specific "features".

Features

  • Read config from pwa.config.js
  • Inject preload e prefetch tags on html files
  • Generate manifesto.json file
  • Generate service-worker.js (files)
  • Generate hashs in scripts and styles files (files)
  • Automate service-worker.js call in your html files

Install

Install with npm

$ npm i pwa-installer

Install with Yarn

$ yarn add pwa-installer

Run with npx (without installing)

$ npx pwa-installer

Note: Install this npm package with the flag -g or --global for global use. Install with the flag -D or --save-dev for add the package as a devDependency of your project.

Usage

$ pwa-installer --help

  Usage:

    $ pwa-installer [<output>] [<options>]

  Options:

    -h, --help              Display help information
    -v, --version           Output version
    -c, --config              Display help information

  Examples:

    $ pwa-installer
    $ pwa-installer dist/index.html
    $ pwa-installer dist --config=pwa.config.js

Note: Directory is required

Contributing

Want to contribute? Follow these recommendations.

License

Designed with ♥ by CJ Patoilo. Licensed under the MIT License.