This repo is a Progressive Web App boilerplate for the ReCode class. It provides the most basic functionality for a PWA, complete with the following necesary files:
- a service worker (
sw.js)- functions as a intermediator between your installed app and the website to manage what files are installed locally on the client machine and grabs new files as updates are made
- a manifest file (
manifest.json)- provides a list of the files and icons needed by the service worker along with other app-related metadata
All of the icon files are in the images folder. These are used for either the home screen icon on Android and iOS or the desktop application icon. They were created with favicon.ico.
NOTE: The a2hs installer fork of this repo provides functionality for an install button on the page, which augments the 'normal' intall process in the URL window.
In order for this web app to be installed, whether on your mobile device or desktop, you must serve the files via a server. This could be a local server or you could upload the files in this repo to a Neocities page.
-
To clone this repo,
cdto your target directory and typegit cloneand the repo link, which is this page's URL. You can also download the zipped contents as well. -
Run a local server from inside of the downloaded folder, for example, using the "Go Live" button in VS Code with Live-Server extension installed.
-
Then in your Chrome browser (recommended), navigate to the
localhostpage in your browser, being careful to note the port number (5500 in the case of Live-Server extension). -
You should be able to install the app by clicking the "Install" icon in the URL window (see pic below).
Here are some helpful references, some of which were used to make this repo: