hru-backend-jquery.ajax
About
A backend for http-request-umd, which performs HTTP requests using jQuery.ajax().
This backend is compatible with http-request-umd >= 1.1.0 .
This backend can be used as an AMD module or as a global variable. At the moment (version 1.0.0), it is not compatible with Node.js, but it may be made compatible soon, probably thanks to a solution like jsdom.
Installation for production
with Node.js
hru-backend-jquery.ajax is available on NPM
You can install it with the following command:
npm install hru-backend-jquery.ajax
Browser globals and AMD
hru-backend-jquery.ajax is available on Bower
To install it from Bower, just run
bower install hru-backend-jquery.ajax
Note that published versions on both NPM and Bower should stay in sync.
Installation for development
You also can download the whole project (and build it from its source; see below).
Either use git clone command to get it:
git clone https://github.com/T1st3/hru-backend-jquery.ajax.git
Or download the latest version of the whole project.
Then, get the dependencies of the project from both Bower and NPM:
npm install
bower install
Documentation
You can find fully functional examples, tests and a documentation in the JSDoc format in the docs folder.
You can also browse these documents and tests online:
Build from source
First, see "Installation for development" above. Do not forget to get the dependencies!
Then, you also need to install Gulp globally to build the project.
npm install -g gulp
See more at the "Getting started with Gulp" page.
Once you got the dependencies and installed Gulp globally, to get info about the package from the command line, just run:
gulp info
You are now ready to build!
The source is located in the "src" folder; the built target is located in the "dist" folder.
To build, just run:
gulp build
Tests
Note that you need a few more dependencies to test the project.
See the tests page for more info
To test, you can use either the npm test command or the gulp test command:
npm test
or
gulp test
Serve and livereload
You can also use the serve task to load the test/ HTML pages in your browser.
gulp serve
Once it has loaded the page in the browser, this task watches for any modification in the source. If changes happen in the source, the task automatically reloads the page in the browser (livereload).
Build the docs and Github pages
Please note that this task has a few more dependencies:
Check the build-docs page for more info.
Credits
See the credits page to see more.
License
This piece of code is triple-licensed: MIT / BSD / GPL licenses
You can also view it in a re-formatted fashion: MIT / BSD / GPL licenses.
