Skip to content

Commit

Permalink
updated README for install notes
Browse files Browse the repository at this point in the history
  • Loading branch information
billythemusical committed Dec 10, 2022
1 parent a569a0a commit a19136f
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Recode PWA Boilerplate

This repo is a Progressive Web App boilerplate for the [ReCode](https://billythemusical.github.io/recode-fa22) class. It provides the most basic functionality for a PWA, complete with the following necesary files:
- a service worker (sw.js)
- 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.json file
- 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 were created with [favicon.ico](https://favicon.io/favicon-converter/)).
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](https://favicon.io/favicon-converter/).

> 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 on your phone, you must serve the files via a website, like Neocities. However, you can install this on a desktop machine by serving the files locally.

# Install Instructions

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.

1) To clone this repo, `cd` to your target directory and type `git clone` and the repo link, which is this page's URL. You can also download the zipped contents as well.

2) 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.
Expand All @@ -22,8 +22,7 @@ In order for this web app to be installed on your phone, you must serve the file

4) You should be able to install the app by clicking the "Install" icon in the URL window (see pic below).


![an image of the Chrome browser window that shows the "Install" button in the URL window.](./images/install-button.jpg)
![an image of the Chrome browser window that shows the "Install" button in the URL window with a red arrow pointing to it.](./images/install-button.jpg)

Here are some helpful references, some of which were used to make this repo:
- [MDN PWA Examples](https://github.com/mdn/pwa-examples)
Expand Down

0 comments on commit a19136f

Please sign in to comment.