You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ja...@apache.org on 2018/11/24 11:11:50 UTC
[cordova-labs] branch janpio-readme created (now 38805e9)
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a change to branch janpio-readme
in repository https://gitbox.apache.org/repos/asf/cordova-labs.git.
at 38805e9 Recreate README
This branch includes the following new commits:
new 38805e9 Recreate README
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[cordova-labs] 01/01: Recreate README
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-readme
in repository https://gitbox.apache.org/repos/asf/cordova-labs.git
commit 38805e9f738df7ffa33d56fa78796ddef493e44d
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Sat Nov 24 12:11:46 2018 +0100
Recreate README
---
README.md | 69 ++++++++++++++++++++++++++++++++++++++++++---------------------
1 file changed, 46 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 6d9ccd9..e4a6e1b 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,57 @@
-Description
-===========
+# Cordova Plugin File-Transfer Test Server
-This the test server for these Cordova FileTransfer Jasmine tests: https://github.com/apache/cordova-plugin-file-transfer/blob/master/tests/tests.js. It runs on cordova-vm.apache.org. Ask Dmitry Blotsky or Richard Knoll to deploy it.
+This the test server for the [Cordova Plugin File-Transfer's Jasmine tests](https://github.com/apache/cordova-plugin-file-transfer/blob/master/tests/tests.js).
-Running
-=======
+It is used on the CI server that is running those tests, a current deployment of the server [is configured there as a parameter](https://github.com/apache/cordova-plugin-file-transfer/blob/master/.travis.yml#L69-L71) (http://sheltered-retreat-43956.herokuapp.com at the time of writing).
+
+## Installation
-Control the server with the following commands (possibly requiring `sudo`):
+```shell
+git clone https://github.com/apache/cordova-labs.git
+cd cordova-labs
+git checkout cordova-filetransfer
+```
+
+## Usage
- service filetserver start
- service filetserver stop
- service filetserver start
- service filetserver restart
+### Running manually
-Updating
-========
+```shell
+node server.js
+```
-Update the server's code with the following commands (possibly requiring `sudo -u filetransfer`):
+### Configuring the File-Transfer plugin tests
- cd /usr/local/filetransfer/cordova-labs
- git pull
- cd ..
- npm install
+Set the [`FILETRANSFER_SERVER_ADDRESS` variable](https://github.com/apache/cordova-plugin-file-transfer/blob/9b322dec6790f6d273b8f707bc07976d778c4cf6/tests/plugin.xml#L33) when installing the plugin tests so they use your local service:
-For the changes to take effect, restart the server.
+```shell
+cordova plugin rm cordova-plugin-file-transfer-tests
+cordova plugin add path/to/cordova-plugin-file-transfer/tests --variable FILETRANSFER_SERVER_ADDRESS="http://yourlocal-IPAddressHere:5000"
+```
-Reference
-=========
+- Get your local IP by running:
-The server is run from an `init.d` script. For more information about `init.d`, see the [Wikipedia page][1] and the [reference][2].
+ ```shell
+ ifconfig # Linux, macOS
+ ipconfig # Windows
+ ```
+
+### Running on a server / as a service
-[1]: https://en.wikipedia.org/wiki/Init
-[2]: http://www.tldp.org/HOWTO/HighQuality-Apps-HOWTO/boot.html
+If your hosting provider supports [Procfiles](https://devcenter.heroku.com/articles/procfile), you don't need to do anything as this project contains one.
+
+Another more manual option is using `forever`:
+
+```
+# install
+npm install -g forever
+
+# start
+forever start server.js
+
+# restart
+forever restart server.js
+
+# stop
+forever start server.js
+```
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org