Normal Programming Mistake
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    kinveypublic

    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.js 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. Add the library

    You can add the library in three ways. The recommended way to add the module to your project is adding a dependency to package.json:

    {
      ...
      "dependencies": {
        "kinvey": "~1.6"
        ...
      }
      ...
    }

    The module will be installed when updating your project:

    npm update

    Alternatively, you can install the module directly from the command line:

    npm install kinvey

    Finally, you can also clone the repository and create a symbolic link to the module:

    git clone git@github.com:Kinvey/kinvey-nodejs.git
    cd kinvey-nodejs
    npm link
    

    3. Configure the library

    Now, the library is available for use in your project. Import the library in your code using require. Next, use Kinvey.init to configure your app:

    var Kinvey = require('kinvey');
    Kinvey.init({
        appKey    : 'App Key',
        appSecret : 'App Secret'
    });

    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({
        success: function(response) {
            console.log('Kinvey Ping Success. Kinvey Service is alive, version: ' + response.version + ', response: ' + response.kinvey);
        },
        error: 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 2015 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.
    

    Keywords

    none

    install

    npm i kinvey

    Downloadsweekly downloads

    66

    version

    1.7.0

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar
    • avatar