From: ebelcrom Date: Sun, 1 Mar 2020 20:23:11 +0000 (+0100) Subject: documentation updated X-Git-Tag: v1.0.0^0 X-Git-Url: http://www.binomiant.duckdns.org/9wAuyR5S/?a=commitdiff_plain;h=287d128055d793a688934e21b97c781a7e52c84b;p=garnod-pwa.git documentation updated --- diff --git a/README.md b/README.md index b047213..c4952bf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,50 @@ # garnod-pwa.git -## Project setup +This is the garage node client application. + +## Getting started + +These instructions let get you a copy of the project and running on it your local machine. + +### Installing + +Get the project using git: + ``` +git clone https://binomiant.duckdns.org/MpqU9XX8/garnod-pwa.git +``` + +Install required packages: + +``` +cd garnod-pwa.git npm install ``` -### Compiles and hot-reloads for development +Compile (with hot-reload) for development by running + ``` npm run serve + +Change `publicPath` to `/` in `vue.config.js` if you experience problems. ``` -### Compiles and minifies for production +Compile (minifies) for production by running + ``` npm run build ``` -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +Your compiled output is located in the `dist` directory. + +You can use a GUI to compile and run the application in your browser: + +``` +vue ui +``` + +For a correct view without scrollable margins replace the meta section in `index.html`: + +``` + +``` diff --git a/src/lib/lib.js b/src/lib/lib.js index f0bc4d4..679f589 100644 --- a/src/lib/lib.js +++ b/src/lib/lib.js @@ -2,7 +2,7 @@ const url = 'https://binomiant.duckdns.org/mVk7Yr3k/v1'; const prodStatus = '/status'; const prodEvents = '/events'; const prodControl = '/control'; -const prodNotification = '/test/notification'; +const prodNotification = '/notification'; const testStatus = '/test/status'; const testEvents = '/test/events'; const testControl = '/test/control'; diff --git a/src/views/Settings.vue b/src/views/Settings.vue index ae173fa..1653577 100644 --- a/src/views/Settings.vue +++ b/src/views/Settings.vue @@ -83,14 +83,14 @@ export default { itemAction: this.setApiKeyInItem, switchAction: this.setApiKeyInSwitch, title: 'Production API-Key', - subtitle: 'Allows access on pruduction features', + subtitle: 'Allows access on production features', }, { value: false, itemAction: this.setPushNotificationInItem, switchAction: this.setPushNotificationInSwitch, title: 'Push notification', - subtitle: 'Allows access on production features', + subtitle: 'Subscribes on open door push notification', }, { value: false,