Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

8 create user documentation #92

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

8 create user documentation #92

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26600cf
Start User Documentation
Jun 30, 2023
4e0af4d
User documentation
Jun 30, 2023
e0a73fa
README changes
Jul 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# 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.

### Current Version: v1.0

### Features:
- Runs on any device with a modern browser
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to define "modern" here a bit

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to add a section with device/browser combinations that have been tested.

- 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 (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 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.
Expand Down