Workbox plugin - Githubissues

jadjoubran / webdash

🔥 Orchestrate your web project with Webdash the customizable web dashboard

https://webdash.xyz

MIT License

1.55k stars 70 forks source link

Workbox plugin #55

Closed jadjoubran closed 6 years ago

jadjoubran commented 6 years ago

Web based configuration wizard for Workbox, originally discussed in workbox#822

jadjoubran commented 6 years ago

Technical analysis:

webdash-workbox would have workbox as a dev dependency
you'll be presented with a start wizard button that spawns npx workbox wizard in the end-user's project directory
the choices that you'd typically see in the console, will be displayed in webdash dashboard, as paper-checkbox or paper-radio-button
this means we don't lose context about the filesystem since the wizard is running in the end-user directory
after the workbox-config has been initialized, the plugin will serve as stats for your generated service-worker: for example, latest version of service worker (cache name), version of workbox running, and the ability to re-run the wizard and override the configuration

Challenges

Being able to answer inquirer's questions programmatically + extracting the questions to the UI

kakadiadarpan commented 6 years ago

@jadjoubran This is amazing! A GUI for workbox would lower the barrier for a lot of people to start using it 😍

jadjoubran commented 6 years ago

Indeed! 😄 I hope to have many webdash plugins that will facilitate building PWAs

jadjoubran commented 6 years ago

Development started 👉jadjoubran/webdash-workbox

Here's the workbox-config.js from webdash:

module.exports = {
  "globDirectory": "build/default",
  "globPatterns": [
  "**/*.{html,js,png,xml,ico,svg,json}",
  ],
  "globIgnores": [
  "bower_components/**"
  ],
  "swDest": "build/default/service-worker.js",
  "runtimeCaching": [{
    urlPattern: /bower_components\//,
    handler: 'cacheFirst',
  }]
};

The webdash workbox plugin will guess some defaults, especially those available in webdash.json runtimeCaching generation won't be supported out of the box (at least not in the first version) and all of these guesses will be validated by the user

jadjoubran commented 6 years ago

Progress:

gif

jadjoubran commented 6 years ago

Video preview

jadjoubran commented 6 years ago

[x] Take screenshot
[x] Record screencast & edit it
[x] Finalize readme.md
[x] Patch release with minor fixes
[x] Add to website + update installation instructions
[x] Add to Documentation