Gulp 4 + UserToken verification fix on Android mobile phones

README.md

@@ -37,6 +37,144 @@ The repo consists of 3 things
 
 All branches and pull requests on Github are auto tested with Travis
 
+### The core firmware (C++)
+
+If you just want to upgrade your Smartcitizen kit please refer to the [Updating the Smartcitizen Kit 2.0](./upgrading.md) guide.
+But if you want to change something and build the firmware, use the [Developer guide: Building and flashing the Smartcitizen Kit firmware](./building.md) guide.
+
+#### SCK Shell
+
+The SCK provides a comprehensive command shell over USB to manage all the kits functionalities for advanced users. 
+
+_Use any Serial console as `screen`, `platformio device monitor`, or the serial monitor on the Arduino IDE_
+
+Example commands:
+
+```
+
+SCK> help
+
+SCK> config -wifi "myWifiName" "myPassword" -token myToken -mode network
+
+```
+
+
+### Frontend + api setup
+You can see the (master branch) mobile UI setup [here](https://fablabbcn.github.io/smartcitizen-kit-20/esp/build_data/)
+
+The technology used here is:
+* HTML, CSS, JavaScript
+* Vue.js
+* ** Make sure it is using the old javascript, so older phones work. **
+
+And the files are under *esp/build_data*
+
+#### Starting frontend development
+
+Inside the `./mock-api` folder do:
+
+1. `npm install`
+
+1. `npm run web` - Starts frontend on [localhost:8000](http://localhost:8000)
+
+1. `npm run api` - Starts a "mock-api" which emulates the Firmware API on [localhost:3000](http://localhost:3000)
+
+1. `gulp` - Watches changes and creates some files automatically, like: `index.html` and `index.gz`
+
+Now you can start editing **esp/build_data/build_index.html**
+
+If your mock-api is not responding, see */esp/build_data/main.js*, **theUrl** should be (your API url:port)
+
+#### Testing frontend
+
+You can run End to End test (for the Web UI) against the current master branch with this command:
+
+`npm test`
+
+If you want the tests to be run automatically everytime you edit `mock-api/casperjs/test` use:
+
+`npm run autotest`
+
+Edit tests under `mock-api/casperjs/test`
+
+####  TODO / ideas:
+
+- [ ] Should we move the frontend to /mock-api, and create a process which compiles it + concatinates and puts the 'dist' in esp/data?
+- [ ] Instead of using a node.js mock-api, can we use the embedded C++ API of the kit somehow?
+
+## Documentation
+
+Full documentation under development. Follow the [forum](https://forum.smartcitizen.me/) and [twitter](https://twitter.com/SmartCitizenKit) for updates.
+
+### The core firmware (C++)
+
+If you just want to upgrade your Smartcitizen kit please refer to the [Updating the Smartcitizen Kit 2.0](./upgrading.md) guide.
+But if you want to change something and build the firmware, use the [Developer guide: Building and flashing the Smartcitizen Kit firmware](./building.md) guide.
+
+#### SCK Shell
+
+The SCK provides a comprehensive command shell over USB to manage all the kits functionalities for advanced users. 
+
+_Use any Serial console as `screen`, `platformio device monitor`, or the serial monitor on the Arduino IDE_
+
+Example commands:
+
+```
+
+SCK> help
+
+SCK> config -wifi "myWifiName" "myPassword" -token myToken -mode network
+
+```
+
+
+### Frontend + api setup
+You can see the (master branch) mobile UI setup [here](https://fablabbcn.github.io/smartcitizen-kit-20/esp/build_data/)
+
+The technology used here is:
+* HTML, CSS, JavaScript
+* Vue.js
+* ** Make sure it is using the old javascript, so older phones work. **
+
+And the files are under *esp/build_data*
+
+#### Starting frontend development
+
+Inside the ./mock-api folder do:
+
+1. `npm install`
+
+1. `npm run web` - Starts frontend on [localhost:8000](http://localhost:8000)
+
+1. `npm run api` - Starts api on [localhost:3000](http://localhost:3000)
+
+1. `gulp watch` - Watches changes and creates 2 files automatically; `final.html` and `index.gz`
+
+Now you can start editing **esp/build_data/build_index.html**
+
+If your mock-api is not responding, see */esp/build_data/main.js*, **theUrl** should be (your API url:port)
+
+#### Testing frontend
+
+You can run End to End test (for the Web UI) against the current master branch with this command:
+
+`npm test`
+
+If you want the tests to be run automatically everytime you edit `mock-api/casperjs/test` use:
+
+`npm run autotest`
+
+Edit tests under `mock-api/casperjs/test`
+
+####  TODO / ideas:
+
+- [ ] Should we move the frontend to /mock-api, and create a process which compiles it + concatinates and puts the 'dist' in esp/data?
+- [ ] Instead of using a node.js mock-api, can we use the embedded C++ API of the kit somehow?
+
+## Documentation
+
+Full documentation under development. Follow the [forum](https://forum.smartcitizen.me/) and [twitter](https://twitter.com/SmartCitizenKit) for updates.
+
 ## Related Smart Citizen repositories
 
 * Platform Core API [github.com/fablabbcn/smartcitizen-api](https://github.com/fablabbcn/smartcitizen-api)