This is the client for our Authorify authentication and authorization middleware for a REST server.
authorify-client as usual:
$ npm install --save authorify-client
You can use
authorify-client both in node and in browser environment.
This client has the same approach of superagent and you can use it as shown below:
// dependenciesvar fs =authorify =host: 'localhost'debug: truekey: fs 'utf8')cert: fs 'utf8')ca: fs 'utf8')uuid =id = uuidapp = uuid;// set a configurationauthorify;// loginauthorify;
To create a single file to use in browser environment use a simple script that uses
and add the obtained
authorify.js file to your
example.js contanins your example code:
// you have a global authorify variableauthorify;// loginauthorify;
test/browser folder to see more examples.
As usual we use mocha as test framework and you can run all tests simply typing:
$ npm test
For other tests (for node and browser) please read Authorify documentation and the local documentation into
To create your own documentation you must install JSDuck and type in your terminal:
$ cd /path-of-package $ ./gen_doc.sh
See full documentation into doc folder.
The version number is laid out as: major.minor.patch and tries to follow semver as closely as possible but this is how we use our version numbering:
A major and possible breaking change has been made in the authorify core. These changes could be not backwards compatible with older versions.
New features are added or a big change has happened with one of the third party libraries.
A bug has been fixed, without any major internal and breaking changes.
To contribute to the project follow the GitHub guidelines.
This program is released under a GNU Affero General Public License version 3 or above, which in summary means:
- You can use this program for no cost.
- You can use this program for both personal and commercial reasons.
- You do not have to share your own program's code which uses this program.
- You have to share modifications (e.g bug-fixes) you've made to this program.
For more convoluted language, see the LICENSE file.