README.md

   1 # Surfer
   2
   3 Surfer is a Simple static file server. It comes with a commandline tool
   4 to upload files from your local folders.
   5
   6 ## Installation
   7
   8 [![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=io.cloudron.surfer)
   9
  10 or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
  11
  12 ```
  13 cloudron install --appstore-id io.cloudron.surfer
  14 ```
  15
  16 ## Building
  17
  18 The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
  19
  20 ```
  21 cd surfer
  22
  23 cloudron build
  24 cloudron install
  25 ```
  26
  27 ### How to upload
  28
  29 You can upload files using the commandline tool.
  30
  31 First, install the surfer cli tool using npm.
  32
  33     sudo npm -g install cloudron-surfer
  34
  35
  36 Login using your Cloudron credentials:
  37
  38     surfer login <this app's url>
  39
  40
  41 Put some files:
  42
  43     surfer put [file]
  44
  45 ## Testing
  46
  47 The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the files are still ok.
  48
  49 ```
  50 cd surfer/test
  51
  52 npm install
  53 USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js
  54 ```
  55