JavaScript SDK

Modern, isomorphic JG client using the Fetch API and promises. Works in IE10 and above using polyfills.

7KB minified.

Getting Started

Bower

$ bower install justgiving-apiclient --save

NPM

$ npm install justgiving-apiclient --save

Download the Source

git clone https://github.com/JustGiving/JustGiving.Api.Sdk.JavaScript.git
cd ./JustGiving.Api.Sdk.JavaScript

Building from source

To get the latest dependencies, build and run tests:

npm install
bower install
npm install -g gulp
gulp

Samples

Browser-based examples - method-samples.html and chained.knockout.html. Node example - server.node.js.

To run the examples, first create a credentials.js file in the examples directory:

var credentials = {
  appId: '{your app ID}',
  basicAuthToken: 'Basic {your base64-encoded username/password}'
};

Then run gulp which will run a local webserver on port 8000.

Roadmap

• [ ] Full API coverage
• [x] Publish to Bower
• [x] Publish to npm
• [ ] Test with Testling
• [ ] Browser examples in gh-pages branch
• [ ] More examples, including Rx
• [ ] JSDoc

Compatibility

The JavaScript API works natively with modern browsers (eg Chrome 43) and using polyfills back to IE10.

License

Copyright (c) 2015 Giving.com Ltd, trading as JustGiving or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.”