Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fingerproof/cordova-plugin-gapreload
LiveReload plugin for Cordova/PhoneGap applications.
https://github.com/fingerproof/cordova-plugin-gapreload
Last synced: 4 months ago
JSON representation
LiveReload plugin for Cordova/PhoneGap applications.
- Host: GitHub
- URL: https://github.com/fingerproof/cordova-plugin-gapreload
- Owner: fingerproof
- License: mit
- Created: 2013-12-04T16:24:27.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-03-01T08:55:38.000Z (almost 7 years ago)
- Last Synced: 2024-06-22T21:11:28.037Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 308 KB
- Stars: 95
- Watchers: 7
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
cordova-plugin-gapreload
========================
*LiveReload* plugin for *Cordova/PhoneGap* applications. [Watch the video demo][demo] (installation procedure a bit outdated, see below instead).
## Installation
Note: if you use the *grunt-gapreload* task, skip these steps and follow [the proper documentation][grunt-gapreload] instead.
1. Install the [LiveReload][LiveReload] app (latest version can be found [here][latest]).
2. Install the [Apache Cordova][Cordova] 3 CLI: `$ npm install -g cordova` (you may need to use `sudo`).
3. `cd` into your Cordova app folder previously created using the `cordova create` command.
4. Install GapReload: `$ cordova plugin add pro.fing.cordova.gapreload --variable SERVER_HOST=""` where `` typically is your localhost IP address (static is better). Note that passing the `SERVER_HOST` is now optional since the plugin will also prompt you to set it at runtime.
5. Follow GapReload instructions in your terminal window and you will be good to go.
## Configuration
The `SERVER_HOST` variable is somehow mandatory. Other available variables are:
| Variable name | Default value |
|-----------------|---------------|
| SERVER_PORT | 8000 |
| LIVERELOAD_HOST | SERVER_HOST |
| LIVERELOAD_PORT | 35729 |
Generally you should not modify those values but, if you really have to, just know that you can.
Setting values for `SERVER_HOST` and `LIVRELOAD_HOST` using the CLI will also automagically [whitelist][whitelist] them for you.
But you can also declare/override values in *plugins/pro.fing.cordova.gapreload/gapreload.xml* like so:
```xml
```
## Removal
Note: if you use the *grunt-gapreload* task, skip these steps and follow [the proper documentation][grunt-gapreload] instead.
Because you shouldn't let this plugin make it to production.
1. `cd` into your Cordova app folder.
2. Execute `$ cordova plugin remove pro.fing.cordova.gapreload`.
3. That's it, GapReload is gone for good.
## Notes
- As GapReload will redirect your whole app to *http://$SERVER_HOST:$SERVER_PORT/*, cross-origin requests won't work anymore [without a proper configuration][cross-origin].
## TODO
- Test on platforms other than iOS and Android and make it work if needed.
## Weird stuff to investigate
- I noticed that when using Chrome 32.0.1700.107 and LiveReload 2.3.34, once every two page refresh, the *livereload.js* file doesn't load at all. An error is thrown and this is what I get for this particular request in the developer tools: *caution provisional headers are shown*...
[grunt-gapreload]: https://github.com/fingerproof/grunt-gapreload
[LiveReload]: http://livereload.com/
[latest]: http://feedback.livereload.com/knowledgebase/articles/67441-how-do-i-start-using-livereload-
[Cordova]: http://cordova.apache.org/docs/en/3.1.0/guide_cli_index.md.html#The%20Command-line%20Interface
[whitelist]: http://cordova.apache.org/docs/en/3.1.0/guide_appdev_whitelist_index.md.html#Whitelist%20Guide
[demo]: https://vimeo.com/81192559
[cross-origin]: https://github.com/fingerproof/cordova-plugin-gapreload/issues/2#issuecomment-45669557