diff options
author | Fulup Ar Foll <fulup@iot.bzh> | 2016-05-28 12:28:19 +0200 |
---|---|---|
committer | Fulup Ar Foll <fulup@iot.bzh> | 2016-05-28 12:28:19 +0200 |
commit | 95a5e12dca0e0e0eb93b3dad69e529d737840d38 (patch) | |
tree | 618f800406d41e6f23e5722671ed51ac0144bd8e /afb-client/README.md | |
parent | 6d06a2a9a02906ce4c848540d74c3c5798688664 (diff) |
Clean up and documentation
Diffstat (limited to 'afb-client/README.md')
-rw-r--r-- | afb-client/README.md | 29 |
1 files changed, 9 insertions, 20 deletions
diff --git a/afb-client/README.md b/afb-client/README.md index 2eb0f6f..8be3dec 100644 --- a/afb-client/README.md +++ b/afb-client/README.md @@ -19,9 +19,6 @@ Install HTML5 development toolchain on your host npm install # this install all development tool chain dependencies sudo npm install --global gulp # this is not mandatory but it will make your live simpler - 4. For livereload functionality [automatic refresh of HTML/CSS] - install [livereload Chrome extension](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei) - ### Overload ./app/etc/AppDefaults.js with '.noderc.js' var config= { @@ -30,34 +27,33 @@ Install HTML5 development toolchain on your host BACKEND : "Backend", // NodeJS Rest API [no leading ./] URLBASE : '/opa/', // HTML basedir when running in production [should end with a /] APIBASE : '/api/', // Api url base dir [should end with a /] - DEBUG : 4001, // Node Debug Port [for mock API debug only] - DBG_LVL : 5, // Debug Trace Level 0=no trace. }; module.exports = config; - WARNING: in current version Frontend/services/AppConfig.js is not updated automatically - you should make sure than your backend config fit with your frontend config. - Note: FCS version should have AppConfig.js configurated automatically from GULP, but this is for "tomorrow" + WARNING: in current development version Frontend/services/AppConfig.js is not updated automatically + you should manually assert that backend config is in sync with frontend config. ### Build project gulp help gulp build-app-dev - gulp watch-dev - http://localhost:3001/opa /* debug mock api base on Backend/RestApi */ + rsync -az dist.dev xxxx@agl-target:afb-client -### Test with Application server binder +### Test with Application # Start AppFramework Binder export MYWORKSPACE=$HOME/Workspace $MYWORKSPACE/afb-daemon/build/afb-daemon --port=1234 --verbose --token=123456789 --rootdir=$MYWORKSPACE/afb-client/dist.dev - Point your browser onto: http://localhost:1234/opa + Point your browser onto: http://agl-target:1234/opa Note: - do not forget '/opa' that should match with your config.URLBASE - if you change --token=xxxx do not forget to update ./Frontend/pages/HomeModules.js - Force HTML/OPA reload with F5 after each HTML5/OPA update or new pages may not be loaded. - - When reloading HTML/OPA with F5 do not forget that your initial token wont be accepted anymore. You should either restart to clean existing session or cleanup AJB_session cookie. + - When reloading HTML/OPA with F5 do not forget that your initial token wont be accepted anymore. You should either: + + restart to clean existing session + + cleanup AJB_session cookie + + start an anonymous web page to get a fresh and clean environment. ### Move to Target cd $MYWORKSPACE/afb-client @@ -72,7 +68,6 @@ Install HTML5 development toolchain on your host |---- package.json |---- bower.json |---- gulpfile.js - |---- .noderc.js [Warning: contains private keys should not uploaded in Github] | |---- /Frontend | | @@ -94,12 +89,6 @@ Install HTML5 development toolchain on your host | |... | | - |---- /Backend - | |-- server.js // launcher - | |----/ models // mogoose database schemas - | |----/ providers // authentication services - | |----/ restapis // application APIs - | |---- (/dist.dev) |---- (/dist.prod) |