djcass44 / redfox2 Goto Github PK

Handbook provider for DOA. Take 2

JavaScript 9.84% HTML 3.85% Vue 83.94% Dockerfile 2.37%

vue pwa javascript

redfox2's Introduction

Redfox2

This application is a Progressive Web App designed to be a simple & easy way to handle online PDFs. This application was built in VueJS 2, however the core non-ui code is written in ES6 Javascript and can be re-used in whatever JS framework you desire.

Further development

Redfox2 is not 100% finished and will require some additional tweaks in order to smoothly integrate into your environment. To continue where we left off, you can look at the issues section. The issues detail the problems we have been having, what we have completed, as well as where we planned on going if we had more time.

The most important tweaks are:

Changing the download URLs in List.vue::created
Making the app check the hash (e-tag) of the PDF before downloading (this stop it from re-downloading the PDF if nothing has changed).

Gotcha's

There are a few things which need to be considered when using this project in production.

PWA Checklist

PWAs have a number of specific requirements in order for the browser to detect it as a valid PWA. Google was kind enough to make a checklist. The most important one is that the entire app MUST BE HTTPS.
CORS

The application attempts to download PDFs from URLs which you define. These URLs must either be on the same URL which the app is hosted, or you must set the appropriate headers.

(our intention was to host PDFs in S3 and set CORS headers to allow app.tld to access the files)

Usage

There are two main methods of hosting this application.

Using docker (recommended)

# build the image
docker build -t redfox2 .
# run the image
docker run -p 80:80 redfox2

The application will now be available at http://localhost:80

Using a 'standard' webserver

# build the project
npm run build
# move the dist folder to your webserver
cp dist /path/to/your/webdir

Development

Install the dependencies
```
npm install
```

Run the development server

# this will start the development server on 8080
npm run serve

Additional references

redfox2's People

Contributors

Make sure storage is empty
Load page
Reload page after 5-10 seconds

Expected: After 2, successfully downloaded document should be available
Actual: Document isn't shown until page is reloaded

PDF opening compat is unknown

Confirmed to work:

Firefox 66.0.1 - Desktop

Not working

Chromium 73.0.3683.75 - Desktop (opens with correct URL but no content)

Tests on Safari Mobile MUST be done.