Package Exports

kinvey-html5-sdk
kinvey-html5-sdk/dist/kinvey

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (kinvey-html5-sdk) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Kinvey

Kinvey (pronounced Kin-vey, like convey) makes it ridiculously easy for developers to setup, use and operate a cloud backend for their mobile apps. They don't have to worry about connecting to various cloud services, setting up servers for their backend, or maintaining and scaling them.

This node and bower module makes it very easy to connect your HTML5 app with Kinvey.

How to use

To use the library, sign up for Kinvey if you have not already done so. Go to the sign up page, and follow the steps provided.

2. Install the library

You can install the module using npm:

npm install kinvey-html5@beta --save

bower install kinvey-html5#3.0.0-beta.7 --save

3. Configure the library

Now, the library is available for use in your project.

If you installed the library with npm, import the library in your code using require.

var Kinvey = require('kinvey-html5');

If you installed the library with bower, add a script tag to your main html file.

<script src="bower_components/kinvey-html5/dist/kinvey.min.js"></script>

Next, use Kinvey.init to configure your app:

Kinvey.init({
    appKey: '<appKey>',
    appSecret: '<appSecret>'
});

4. Verify Set Up

You can use the following snippet to verify the app credentials were entered correctly. This function will contact the backend and verify that the library can communicate with your app.

Kinvey.ping().then(function(response) {
  console.log('Kinvey Ping Success. Kinvey Service is alive, version: ' + response.version + ', response: ' + response.kinvey);
}).catch(function(error) {
  console.log('Kinvey Ping Failed. Response: ' + error.description);
});

What’s next?

You are now ready to start building your awesome apps! Next we recommend diving into the User guide or Data store guide to learn more about our service, or explore the sample apps to go straight to working projects.

License

Copyright 2016 Kinvey, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License 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.

kinvey-html5-sdk