From f165004c10448d0f0f0d09093a44c8e01475ea68 Mon Sep 17 00:00:00 2001 From: Nate Moore Date: Mon, 22 Nov 2021 20:03:45 -0600 Subject: [PATCH] Add `with-vite-plugin-pwa` example (#1829) --- examples/with-vite-plugin-pwa/.gitignore | 18 + examples/with-vite-plugin-pwa/.npmrc | 2 + examples/with-vite-plugin-pwa/.stackblitzrc | 6 + examples/with-vite-plugin-pwa/README.md | 43 + .../with-vite-plugin-pwa/astro.config.mjs | 16 + examples/with-vite-plugin-pwa/package.json | 15 + .../with-vite-plugin-pwa/public/favicon.ico | Bin 0 -> 4286 bytes .../with-vite-plugin-pwa/public/robots.txt | 2 + .../with-vite-plugin-pwa/sandbox.config.json | 11 + examples/with-vite-plugin-pwa/src/index.ts | 10 + .../src/pages/index.astro | 18 + .../with-vite-plugin-pwa/src/vite-env.d.ts | 11 + examples/with-vite-plugin-pwa/tsconfig.json | 3 + packages/astro/src/core/build/index.ts | 4 +- packages/astro/src/core/create-vite.ts | 2 +- yarn.lock | 1451 ++++++++++++++++- 16 files changed, 1575 insertions(+), 37 deletions(-) create mode 100644 examples/with-vite-plugin-pwa/.gitignore create mode 100644 examples/with-vite-plugin-pwa/.npmrc create mode 100644 examples/with-vite-plugin-pwa/.stackblitzrc create mode 100644 examples/with-vite-plugin-pwa/README.md create mode 100644 examples/with-vite-plugin-pwa/astro.config.mjs create mode 100644 examples/with-vite-plugin-pwa/package.json create mode 100644 examples/with-vite-plugin-pwa/public/favicon.ico create mode 100644 examples/with-vite-plugin-pwa/public/robots.txt create mode 100644 examples/with-vite-plugin-pwa/sandbox.config.json create mode 100644 examples/with-vite-plugin-pwa/src/index.ts create mode 100644 examples/with-vite-plugin-pwa/src/pages/index.astro create mode 100644 examples/with-vite-plugin-pwa/src/vite-env.d.ts create mode 100644 examples/with-vite-plugin-pwa/tsconfig.json diff --git a/examples/with-vite-plugin-pwa/.gitignore b/examples/with-vite-plugin-pwa/.gitignore new file mode 100644 index 000000000..d436c6dad --- /dev/null +++ b/examples/with-vite-plugin-pwa/.gitignore @@ -0,0 +1,18 @@ +# build output +dist + +# dependencies +node_modules/ +.snowpack/ + +# logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# environment variables +.env +.env.production + +# macOS-specific files +.DS_Store diff --git a/examples/with-vite-plugin-pwa/.npmrc b/examples/with-vite-plugin-pwa/.npmrc new file mode 100644 index 000000000..65922326b --- /dev/null +++ b/examples/with-vite-plugin-pwa/.npmrc @@ -0,0 +1,2 @@ +## force pnpm to hoist +shamefully-hoist = true diff --git a/examples/with-vite-plugin-pwa/.stackblitzrc b/examples/with-vite-plugin-pwa/.stackblitzrc new file mode 100644 index 000000000..43798ecff --- /dev/null +++ b/examples/with-vite-plugin-pwa/.stackblitzrc @@ -0,0 +1,6 @@ +{ + "startCommand": "npm start", + "env": { + "ENABLE_CJS_IMPORTS": true + } +} \ No newline at end of file diff --git a/examples/with-vite-plugin-pwa/README.md b/examples/with-vite-plugin-pwa/README.md new file mode 100644 index 000000000..b078cf708 --- /dev/null +++ b/examples/with-vite-plugin-pwa/README.md @@ -0,0 +1,43 @@ +# Astro Starter Kit: Minimal + +``` +npm init astro -- --template minimal +``` + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/snowpackjs/astro/tree/latest/examples/minimal) + +> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +``` +/ +├── public/ +├── src/ +│ └── pages/ +│ └── index.astro +└── package.json +``` + +Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. + +There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. + +Any static assets, like images, can be placed in the `public/` directory. + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +|:---------------- |:-------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat). diff --git a/examples/with-vite-plugin-pwa/astro.config.mjs b/examples/with-vite-plugin-pwa/astro.config.mjs new file mode 100644 index 000000000..29194f9d6 --- /dev/null +++ b/examples/with-vite-plugin-pwa/astro.config.mjs @@ -0,0 +1,16 @@ +import { VitePWA } from 'vite-plugin-pwa' + +// Full Astro Configuration API Documentation: +// https://docs.astro.build/reference/configuration-reference + +// @type-check enabled! +// VSCode and other TypeScript-enabled text editors will provide auto-completion, +// helpful tooltips, and warnings if your exported object is invalid. +// You can disable this by removing "@ts-check" and `@type` comments below. + +// @ts-check +export default /** @type {import('astro').AstroUserConfig} */ ({ + vite: { + plugins: [VitePWA()] + } +}); diff --git a/examples/with-vite-plugin-pwa/package.json b/examples/with-vite-plugin-pwa/package.json new file mode 100644 index 000000000..4b741c78a --- /dev/null +++ b/examples/with-vite-plugin-pwa/package.json @@ -0,0 +1,15 @@ +{ + "name": "@example/with-vite-plugin-pwa", + "version": "0.0.1", + "private": true, + "scripts": { + "dev": "astro dev", + "start": "astro dev", + "build": "astro build", + "preview": "astro preview" + }, + "devDependencies": { + "astro": "^0.21.0-next.3", + "vite-plugin-pwa": "^0.11.5" + } +} diff --git a/examples/with-vite-plugin-pwa/public/favicon.ico b/examples/with-vite-plugin-pwa/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..578ad458b8906c08fbed84f42b045fea04db89d1 GIT binary patch literal 4286 zcmchZF=!M)6ox0}Fc8GdTHG!cdIY>nA!3n2f|wxIl0rn}Hl#=uf>?-!2r&jMEF^_k zh**lGut*gwBmoNv7AaB&2~nbzULg{WBhPQ{ZVzvF_HL8Cb&hv$_s#qN|IO^o>?+mA zuTW6tU%k~z<&{z+7$G%*nRsTcEO|90xy<-G5&JTt%CgZZCDT4%R?+{Vd^wh>P8_)} z`+dF$HQb9!>1o`Ivn;GInlCw{9T@Rt%q+d^T3Ke%cxkk;$v`{s^zCB9nHAv6w$Vbn z8fb<+eQTNM`;rf9#obfGnV#3+OQEUv4gU;{oA@zol%keY9-e>4W>p7AHmH~&!P7f7!Uj` zwgFeQ=<3G4O;mwWO`L!=R-=y3_~-DPjH3W^3f&jjCfC$o#|oGaahSL`_=f?$&Aa+W z2h8oZ+@?NUcjGW|aWJfbM*ZzxzmCPY`b~RobNrrj=rd`=)8-j`iSW64@0_b6?;GYk zNB+-fzOxlqZ?`y{OA$WigtZXa8)#p#=DPYxH=VeC_Q5q9Cv`mvW6*zU&Gnp1;oPM6 zaK_B3j(l^FyJgYeE9RrmDyhE7W2}}nW%ic#0v@i1E!yTey$W)U>fyd+!@2hWQ!Wa==NAtKoj`f3tp4y$Al`e;?)76?AjdaRR>|?&r)~3Git> zb1)a?uiv|R0_{m#A9c;7)eZ1y6l@yQ#oE*>(Z2fG-&&smPa2QTW>m*^K65^~`coP$ z8y5Y?iS<4Gz{Zg##$1mk)u-0;X|!xu^FCr;ce~X<&UWE&pBgqfYmEJTzpK9I%vr%b z3Ksd6qlPJLI%HFfeXK_^|BXiKZC>Ocu(Kk6hD3G-8usLzVG^q00Qh gz)s7ge@$ApxGu7=(6IGIk+uG&HTev01^#CH3$(Wk5&!@I literal 0 HcmV?d00001 diff --git a/examples/with-vite-plugin-pwa/public/robots.txt b/examples/with-vite-plugin-pwa/public/robots.txt new file mode 100644 index 000000000..1f53798bb --- /dev/null +++ b/examples/with-vite-plugin-pwa/public/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/examples/with-vite-plugin-pwa/sandbox.config.json b/examples/with-vite-plugin-pwa/sandbox.config.json new file mode 100644 index 000000000..9178af77d --- /dev/null +++ b/examples/with-vite-plugin-pwa/sandbox.config.json @@ -0,0 +1,11 @@ +{ + "infiniteLoopProtection": true, + "hardReloadOnChange": false, + "view": "browser", + "template": "node", + "container": { + "port": 3000, + "startScript": "start", + "node": "14" + } +} diff --git a/examples/with-vite-plugin-pwa/src/index.ts b/examples/with-vite-plugin-pwa/src/index.ts new file mode 100644 index 000000000..af679697f --- /dev/null +++ b/examples/with-vite-plugin-pwa/src/index.ts @@ -0,0 +1,10 @@ +import { registerSW } from 'virtual:pwa-register' + +const updateSW = registerSW({ + onNeedRefresh() {}, + onOfflineReady() { + console.log("Offline ready"); + } +}) + +updateSW(); diff --git a/examples/with-vite-plugin-pwa/src/pages/index.astro b/examples/with-vite-plugin-pwa/src/pages/index.astro new file mode 100644 index 000000000..008442824 --- /dev/null +++ b/examples/with-vite-plugin-pwa/src/pages/index.astro @@ -0,0 +1,18 @@ +--- +--- + + + + + + + + Welcome to Astro + + + +

Welcome to Astro

+