cubx-authentication-client
v1.1.0
Published
request a token for client-base-interactions
Downloads
15
Readme
cubx-authentication-client
This lib is part of the Cubbles platform. Use this lib to request an 'access_token' for Client > Base -interactions.
Install
$ npm install --save cubx-authentication-client
API
var cubxAuthenticationClient = require('cubx-authentication-client');
cubxAuthenticationClient('https://<your-cubbles-base-host>/_api/auth', 'store1', 'username', 'password', function(err, access_token) {...});
CLI - local usage
# usage instructions
$ node bin/cubxAuthenticationClient
CLI - global install
# install
$ npm install --global cubx-authentication-client
# usage instructions
$ cubx-authentication-client
Contribution
Testing
Currently testcases require a Cubble-Base-Instance available at http://boot2docker.me. Contact the author, if your have questions on how to setup a Base locally.
Pre-Commit Hooks
To make sure, only correctly styled and tested code will be commited, we use pre-commit hooks managed with the npm-module pre-commit
.
On Windows, installing the pre-commit -hook fails with a message like pre-commit: EPERM: operation not permitted, symlink ...
To create the symlink, please open a cmd 'as administrator' and run npm install
. Check the .git/hooks
folder for the new created symlink.
Notes
Project has been generated using https://github.com/maurizzzio/generator-node-npm
License
2016 Apache-2.0 © Cubbles