Skip to content
Kinvey JavaScript Library for Node.js.
JavaScript
Latest commit d9234b6 Apr 6, 2016 @ThomasConner ThomasConner Merge branch 'release/3.0.0-beta.14'
* release/3.0.0-beta.14:
  Update Build
  Bump version to 3.0.0-beta.14
Failed to load latest commit information.
build
src
.editorconfig
.eslintrc
.gitattributes Updated to version 3.0.0-beta.1 Jan 29, 2016
.gitignore
LICENSE Updating to new sdk structure Feb 26, 2016
README.md
gulpfile.js
package.json

README.md

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 module makes it very easy to connect your Node app with Kinvey.

How to use

1. Sign up for Kinvey

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@beta --save

3. Configure the library

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

Import the library in your code using require.

var Kinvey = require('kinvey');

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.
Something went wrong with that request. Please try again.