generator-kinvey-angular

generator-kinvey-angular

Build a complete AngularJS app connected to your Kinvey backend.

How to Use Locally

• Install Yeoman (we assume you have pre-installed node.js).

#Install yeoman
npm install -g yo

• Install ionic. If you have it already, skip this step.

#Install ionic
npm install -g ionic

• Clone this repo. From the root folder, run npm install followed by npm link.

#Clone the repo
git clone <repo-url>

#Install dependencies
npm install

#Install the package globally as a symlink
npm link

• Navigate to a folder where you'd like your new project (this should be different from the folder where you cloned this generator). Call yo kinvey-angular to kick off a new project.

cd ~/Desktop
yo kinvey-angular

• You will be prompted for your Kinvey credentials. If you don't have a Kinvey account yet, please sign up for one here. We also recommend having at least one collection in your app before walking through the next steps.

• The generator will walk you through selecting an application environment and adding some collections to your client app. Make your selections and watch as the generator spins off a new Angular app, adds views for the collections you picked and then installs the dependencies.

Note: the tool assumes that each collection has a name and description field, and uses the values of these fields in the UI. This assumption will likely be removed in the future.

• Serve up the app you just built with ionic serve (this runs it in a browser, use other ionic commands to run it in a device)

ionic serve

License

Copyright (c) 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.