Kinvey JS SDK
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.
The JS SDK is used as a way to share common code for platform specific SDK shims. Here is a list of the platforms we currently support, each as a separate repo -
Refer to the Kinvey DevCenter for documentation on using Kinvey.
How to use
Please visit one the platform specific SDK shims and read the README with help on how to use the SDK.
Build
npm run build
Release
TravisCI will deploy the package to NPM.
- Checkout the master branch.
- Update the CHANGELOG.md.
- Execute
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
. See Version Management for more info on incrementing the version. - Done.
Version Management
Updating the package version should follow Semantic Version 2.0.0:
- Major (x.0.0): when making an incompatible API changes.
- Minor (3.x.0): when adding functionality in a backwards-compatible manner.
- Patch (3.0.x): when making backwards-compatible bug fixes or enhancements.
Test
Note: Before running any tests you will need to run npm install
to install any dependencies required.
Unit Tests
npm test
License
See LICENSE for details.
Contributing
See CONTRIBUTING.md for details on reporting bugs and making contributions.