Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
create-pwa
Advanced tools
create-pwa - npm Package Compare versions
Comparing version 0.0.0 to 0.1.0
| { | ||
| "name": "create-pwa", | ||
| "version": "0.0.0", | ||
| "version": "0.1.0", | ||
| "description": "Easily create a progressive web app", | ||
| "keywords": "PWA, CLI, Scaffold", | ||
| "main": "index.js", | ||
| "scripts": { | ||
| "test": "node ./test/index.js" | ||
| }, | ||
| "bin": { | ||
| "create-pwa": "./src/index.js" | ||
| }, | ||
| "keywords": [ | ||
| "PWA", | ||
| "CLI", | ||
| "Scaffold", | ||
| "manifest", | ||
| "webapp", | ||
| "service-worker" | ||
| ], | ||
| "main": "src/index.js", | ||
| "repository": "git@github.com:scriptex/create-pwa.git", | ||
@@ -14,3 +27,7 @@ "bugs": { | ||
| "license": "MIT", | ||
| "private": false | ||
| "dependencies": {}, | ||
| "devDependencies": { | ||
| "sharp": "^0.20.2", | ||
| "yargs": "^11.0.0" | ||
| } | ||
| } |
114
README.md
@@ -0,1 +1,13 @@ | ||
| [](https://github.com/scriptex/create-pwa) | ||
| [](https://github.com/scriptex/create-pwa/network#fork-destination-box) | ||
| [](https://github.com/scriptex/create-pwa/releases/latest) | ||
| [](https://github.com/scriptex/create-pwa/issues) | ||
| [](https://github.com/scriptex/create-pwa/commits/master) | ||
| [](https://www.npmjs.com/package/create-pwa) | ||
| [](https://www.npmjs.com/package/create-pwa) | ||
| [](https://github.com/scriptex/create-pwa) | ||
| [](https://github.com/scriptex/create-pwa/) | ||
| [](https://github.com/scriptex/create-pwa/) | ||
| [](https://github.com/scriptex/create-pwa/graphs/commit-activity) | ||
| # create-pwa | ||
@@ -5,4 +17,102 @@ | ||
| ## Todo | ||
| --- | ||
| Add README :| | ||
| 🛠 Status: In Development: `create-pwa` is in constant development. | ||
| --- | ||
| ## About | ||
| `create-pwa` is a module for quick scaffolding and producing of progressive web applications. | ||
| `create-pwa` adds the minimum required boilerplate which your app requires in order to become a PWA. | ||
| `create-pwa` can be used with existing applications or can be the first thing one does when starting a new app. | ||
| ## Dependencies | ||
| In order to use this module, you must have NodeJS installed and NPM or Yarn available. | ||
| ## Install | ||
| You can either install `create-pwa` globally: | ||
| ```console | ||
| npm i -g create-pwa | ||
| ``` | ||
| or use `npx`: | ||
| ```console | ||
| npx create-pwa | ||
| ``` | ||
| ## Arguments | ||
| `icon`: Specifies relative path to the application icon. This path is relative to the folder you are located in currently (`your/app/folder`). | ||
| ## Usage | ||
| First, navigate to your application's folder: | ||
| Then run the install command (see above) | ||
| ```console | ||
| cd your/app/folder | ||
| npx create-pwa --icon="./icon.png" | ||
| ``` | ||
| The above command will generate a `manifest.json`, `service-worker.js` file and several (8) png icons in the `/icons/` folder in your app's root folder. | ||
| You can edit the contents of the `manifest.json` and `service-worker.js` files. | ||
| Their default content is based on industry's best practices and is highly opinionated. | ||
| In order to create a customized experience for your users, feel advised to revise and edit the contents of the above files. | ||
| When the files(`manifest.json` and `service-worker.js`) are ready for production, you need to let the world know about them: | ||
| 1. Add the following to the `head` of your HTML file(s): | ||
| ```html | ||
| <link rel="manifest" href="manifest.json" /> | ||
| ``` | ||
| You can read more about the Web App Manifest [here](https://developers.google.com/web/fundamentals/web-app-manifest/). | ||
| 2. Add the following snippet to your application's JavaScript bundle or place it in a `script` tag just before the closing `</body>` tag in your HTML file(s): | ||
| ```js | ||
| if ('serviceWorker' in navigator) { | ||
| window.addEventListener('load', function() { | ||
| navigator.serviceWorker.register('./service-worker.js').then( | ||
| function(registration) { | ||
| // Registration was successful | ||
| console.log( | ||
| 'ServiceWorker registration successful with scope: ', | ||
| registration.scope | ||
| ); | ||
| }, | ||
| function(err) { | ||
| // registration failed :( | ||
| console.log('ServiceWorker registration failed: ', err); | ||
| } | ||
| ); | ||
| }); | ||
| } | ||
| ``` | ||
| You can read more about Service Workers [here](https://developers.google.com/web/fundamentals/primers/service-workers/). | ||
| ## More info | ||
| There is a lot information about Progressive Web Applications on the Internet. | ||
| In order to comply with browser's requirements and pass the audits you need to check out and fulfill the [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist). | ||
| The entries listed in **Baseline Progressive Web App Checklist** are mandatory and without them your web app will not qualify as a PWA. | ||
| If you wish to test your web app's compliance, you can use the Chrome's built-in Lighthouse tool (found under the _Audits_ tab in the Developer tools). | ||
| ## LICENSE | ||
| MIT |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Trivial Package
Supply chain riskPackages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2475%
47174
- Number of package files
- increased by125%
9
- Lines of code
- increased by2312.5%
193
- Number of lines in readme file
- increased by1375%
118
Worsened metrics
- Dev dependency count
- increased byInfinity%
2
- Number of low supply chain risk alerts
- increased by150%
5
No dependency changes