diff options
Diffstat (limited to 'afm-client/README.md')
| -rw-r--r-- | afm-client/README.md | 41 |
1 files changed, 18 insertions, 23 deletions
diff --git a/afm-client/README.md b/afm-client/README.md index 0ed9d45..3bb94a2 100644 --- a/afm-client/README.md +++ b/afm-client/README.md @@ -1,3 +1,8 @@ +### Sample client application for Application Framework Binder + + + +_(Application Framework Binder can be found on https://github.com/iotbzh/afb-daemon)_ ## Installation @@ -14,57 +19,54 @@ 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= { APPNAME : 'AFBclient', // AppName is use as main Angular Module name FRONTEND: "Frontend", // HTML5 frontend [no leading ./] - 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 : 5003, // 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:4003/opa /* debug mock api base on Backend/RestApi */ + rsync -az dist.dev xxxx@agl-target:afm-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/afm-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 afb-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/afm-client gulp build-app-prod - scp -r ./dist.prod/* user@mytarget:/rootdir/apfDaemon + scp -r ./dist.prod/* user@mytarget:/rootdir/afm-client + ssh user@mytarget "afb-daemon --port=3001 --token='' --rootdir=/rootdir/afm-client" + http://mytarget:3001/opa +### Directory structure /AppClient | |---- package.json |---- bower.json |---- gulpfile.js - |---- .noderc.js [Warning: contains private keys should not uploaded in Github] | |---- /Frontend | | @@ -86,13 +88,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) - |