From 26600cf70fea85550fadc437bbaabad1f764d4f2 Mon Sep 17 00:00:00 2001 From: holl695 Date: Fri, 30 Jun 2023 13:31:47 -0700 Subject: [PATCH 1/3] Start User Documentation --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e90d70eb..f7f8a469 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -# BASC QA Tool - +# Quality Install Tool +The Quality Install Tool is a web app that implements quality installation documentation requirements for various residential energy efficiency upgrades developed by Pacific Northwest National Laboratory (PNNL) as described at http://pnnl.gov/projects/quality-install-tool. Importantly, the requirements list a set of photos that must be taken before, during, and/or after installation. + +### Features +- Runs on any device with a modern browser +- Runs entirely inside the browser +- All data are stored on the user's device – no data is sent to a server +- Will run offline – no internet connection is neccessary once it is installed +- Generates a PDF report that is stored on the user's device – the user may email, or otherwise transfer, the PDF to others separately from the web app + +## Using the Web App +- The web app is publicly accessible at https://quality-install-tool.pnnl.gov/. Visiting this site will automatically install the web app in the browser's App Cache for offline use. +- The initial (home) screen allows the user to select from a list of installation types. +- Choosing an installation type takes the user to ## An outline of the App startup process 1. The server will serve the built (by webpack) version of `index.html` for any route. 2. `index.html` will load `index.css` and `App.css`. From 4e0af4d229779ac74801c8cb64150baca0dabd34 Mon Sep 17 00:00:00 2001 From: holl695 Date: Fri, 30 Jun 2023 16:20:27 -0700 Subject: [PATCH 2/3] User documentation --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f7f8a469..98089c7b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ # Quality Install Tool The Quality Install Tool is a web app that implements quality installation documentation requirements for various residential energy efficiency upgrades developed by Pacific Northwest National Laboratory (PNNL) as described at http://pnnl.gov/projects/quality-install-tool. Importantly, the requirements list a set of photos that must be taken before, during, and/or after installation. -### Features +### Current Version: v1.0 + +### Features: - Runs on any device with a modern browser - Runs entirely inside the browser - All data are stored on the user's device – no data is sent to a server -- Will run offline – no internet connection is neccessary once it is installed -- Generates a PDF report that is stored on the user's device – the user may email, or otherwise transfer, the PDF to others separately from the web app +- Will run offline – no internet connection is neccessary once it is installed (Coming Soon) +- Generates a PDF report that is stored on the user's device – the user may send the PDF to others separately from the web app ## Using the Web App -- The web app is publicly accessible at https://quality-install-tool.pnnl.gov/. Visiting this site will automatically install the web app in the browser's App Cache for offline use. +- The web app is publicly accessible at https://quality-install-tool.pnnl.gov. - The initial (home) screen allows the user to select from a list of installation types. -- Choosing an installation type takes the user to + - The current version only supports the Heat Pump Water Heater installation. (More are coming soon) +- Choosing an installation type takes the user to the Projects List for that installation type. + - The user can create new projects and rename, delete, or open existing projects. +- Opening a project takes the user to a project page where the user can fill in the input form(s), add photos, and generate a PDF report. + +### Supported Photo Types: +The current version only supports JPEG photos. (Newer iPhones store photos in the HEIC format by default. To store photos in the web app, you will need to change the camera settings to store photos in JPEG format.) + +### Offline Support: +The current version does not support offline use. Once the web app has been thoroughly tested by others, we will turn this feature on. + ## An outline of the App startup process 1. The server will serve the built (by webpack) version of `index.html` for any route. 2. `index.html` will load `index.css` and `App.css`. From e0a73faf9844649324e762c9836ff24fee8b17e7 Mon Sep 17 00:00:00 2001 From: holl695 Date: Sun, 9 Jul 2023 14:27:24 -0700 Subject: [PATCH 3/3] README changes --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 98089c7b..9e5d953d 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,16 @@ The Quality Install Tool is a web app that implements quality installation docum - Runs on any device with a modern browser - Runs entirely inside the browser - All data are stored on the user's device – no data is sent to a server +- Photos are taken with the device camera while on the job site +- All photos are timestamped and geotagged when uploaded - Will run offline – no internet connection is neccessary once it is installed (Coming Soon) - Generates a PDF report that is stored on the user's device – the user may send the PDF to others separately from the web app ## Using the Web App - The web app is publicly accessible at https://quality-install-tool.pnnl.gov. -- The initial (home) screen allows the user to select from a list of installation types. - - The current version only supports the Heat Pump Water Heater installation. (More are coming soon) -- Choosing an installation type takes the user to the Projects List for that installation type. +- The initial (home) screen allows the user to select from a list of workflows. + - The current version only supports the Heat Pump Water Heater workflow. (More are coming soon.) +- Choosing an installation type takes the user to the Projects List for that workflow. - The user can create new projects and rename, delete, or open existing projects. - Opening a project takes the user to a project page where the user can fill in the input form(s), add photos, and generate a PDF report.