diff options
author | Alex <i@neonxp.dev> | 2023-03-08 19:27:35 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-08 19:27:35 +0300 |
commit | df52915806db050a8e0cfab2d686acfdbf5e0c5c (patch) | |
tree | 237533159fe116e01dd0712084d9473db1148edd /README.md |
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..09f50ce --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# pwa-starter + +Please use our [main repository for any issues/bugs/features suggestion](https://github.com/pwa-builder/PWABuilder/issues/new/choose). + +[Documentation](https://docs.pwabuilder.com/#/starter/quick-start) + +The PWABuilder pwa-starter is our opinionated, best practices, production tested starter that we use to build all of our PWAs, including [PWABuilder itself](https://blog.pwabuilder.com/posts/introducing-the-brand-new-pwa-builder/)! The pwa-starter is a starter codebase, just like create-react-app or the Angular CLI can generate, that uses the PWABuilder team's preferred front-end tech stack. + +[![Get started with the pwa-starter!](https://img.youtube.com/vi/u3pWKpmic_k/0.jpg)](https://www.youtube.com/watch?v=u3pWKpmic_k) + +With it you get an app that: +- Has no build system to set up and no boilerplate code to add. Everything is included out of the box. +- Has a Service Worker system using [Workbox](https://developers.google.com/web/tools/workbox/) +- Scores close to 100 on Lighthouse out of the box +- Has everything needed to be installable in the browser +- Is ready to be package for the app stores using [PWABuilder](https://www.pwabuilder.com) +- Uses the [Azure Static Web Apps CLI](https://azure.github.io/static-web-apps-cli) which enables emulating your production environment locally, and gets you ready for deploying to Azure Static Web Apps! + +and all with just a few button clicks 😊. + +[Get Started!](https://docs.pwabuilder.com/#/starter/quick-start) + +## Sample PWAs built with the starter! + +- SimpleEdit: Simple Image editing and collage making app! + - Github: https://github.com/jgw96/simple-edit-2 + - Web: https://gray-pond-01ccec410.azurestaticapps.net/ + - Microsoft Store: https://www.microsoft.com/store/productId/9P53Q9BF3MV6 + - Google Play: https://play.google.com/store/apps/details?id=net.azurestaticapps.thankful_tree_07da4921e.twa&hl=en&gl=US + +- Mail GO: Full featured email client. This app aims to show the power of the web by integrating many of the advanced APIs now avilable to PWAs, such as [receiving content shared from another app](https://docs.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/how-to/share#receiving-shared-content), [a custom titlebar](https://docs.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/how-to/window-controls-overlay), [sycing data in the background](https://docs.microsoft.com/en-us/microsoft-edge/progressive-web-apps-chromium/how-to/background-syncs) and more! + - Github: https://github.com/jgw96/graph-app + - Web: https://www.memosapp.app + - Microsoft Store: https://www.microsoft.com/store/productId/9NQW566N4866 + +## More Resources +- [The pwa-starter docs](https://docs.pwabuilder.com/#/starter/quick-start) |