Skip to content

Commit

Permalink
Merge pull request #973 from FlowFuse/docs-pwa
Browse files Browse the repository at this point in the history
Docs: Add details on how to "install" PWA on Android/iOS
  • Loading branch information
joepavitt authored Jun 14, 2024
2 parents 811f93a + 2de377e commit b5255b7
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ export default ({ mode }) => {
{ text: 'Dynamic Properties', link: '/user/dynamic-properties' },
{ text: 'Migration Guide', link: '/user/migration' },
{ text: 'UI Template Examples', link: '/user/template-examples' },
{ text: 'Subflows', link: '/user/subflows' }
{ text: 'Subflows', link: '/user/subflows' },
{ text: 'Installing on Mobile', link: '/user/pwa' }
]
},
{
Expand Down
Binary file added docs/assets/images/pwa-android-install.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/pwa-android-options.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/pwa-ios-install.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/pwa-ios-options.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/user/pwa.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

<script setup>
import AddedIn from '../components/AddedIn.vue';
</script>

# Installing Dashboards on Mobile <AddedIn version="1.9.0" />

Node-RED Dashboard 2.0 is built and deployed as a [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps). This means whilst it's built as a web application, it can be installed on your mobile device and run as a standalone application, behaving as if it was a native app.

## Installing on Android

To install the Dashboard on an Android device, open the browser and navigate to your Dashboard. From the browser's options, select _"Add to Home Screen"_ (you may be presented directly with an option to _"Install"_ here, depending on your Chrome version):

<img src="../assets/images/pwa-android-options.jpg" alt="Options presented in Chrome on Android" style="max-width: 300px;margin: auto;">
<em>Options presented in Chrome on Android</em>

This will then prompt you to either "Install" Dashboard as an application, or "Create a Shortcut" on your home screen:

<img src="../assets/images/pwa-android-install.jpg" alt="Options presented in Chrome on Android" style="max-width: 300px;margin: auto;">
<em>Options presented in Chrome on Android</em>

If you install, the Dashboard will be added to your home screen and can be launched as a standalone application, without the surrounding Browser experience.

## Installing on iOS

To install the Dashboard on an iOS device, open the browser and navigate to your Dashboard. From the browser's options, select _"Add to Home Screen"_:

<img src="../assets/images/pwa-ios-options.jpg" alt="Options presented in Safari on iOS" style="max-width: 300px;margin: auto;">
<em>Options presented in Safari on iOS</em>

You'll then be prompted to name your application:

<img src="../assets/images/pwa-ios-install.jpg" alt="Options presented in Safari on Android" style="max-width: 300px;margin: auto;">
<em>Options presented in Safari on iOS</em>

0 comments on commit b5255b7

Please sign in to comment.