Easily make Cordova projects with Steal
JavaScript HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
lib
test
.editorconfig
.gitignore
.npmignore
.travis.yml
README.md
license.md
package.json

README.md

npm version

steal-cordova

Develop your project as a web application and then simply use steal-cordova to create Android and iOS Cordova apps.

Install

npm install steal-cordova --save-dev

If you are developing for android you also need to install the Android SDK and Ant. You have a lot of options on how to do this. If using OSX the easiest way is with Homebrew:

brew install android-sdk ant

After installing set the ANDROID_HOME environmental variable:

export ANDROID_HOME=/usr/local/opt/android-sdk

To make this permanent set it in your .bashrc or .zshrc or whatever shell you use.

Example

steal-cordova needs a BuildResult object which you get from running StealTools multi-build:

var stealTools = require("steal-tools");

var cordovaOptions = {
  buildDir: "./build/cordova",
  id: "com.hello.world",
  name: "HelloWorld",
  platforms: ["ios", "android"],
  index: __dirname + "/index.html"
};

var stealCordova = require("steal-cordova")(cordovaOptions);

var buildPromise = stealTools.build({
  config: __dirname + "/package.json!npm"
});

buildPromise.then(stealCordova.build);

API

Pass in your Cordova options to steal-cordova to create a stealCordova object that can be used to run builds, start emulators and run on Android devices.

stealCordova

var stealCordova = require("steal-cordova")(cordovaOptions);

stealCordova.build

stealCordova.build(buildResult) -> Promise

Pass a BuildResult object from StealTools' multi build. Returns a Promise that will resolve when the Cordova application has built.

stealCordova.android.emulate

stealCordova.android.emulate() -> Promise

Call to start an Android emulator with your project. Returns a promise that will resolve when the application has booted.

stealCordova.android.run

stealCordova.android.run() -> Promise

Run your application on an Android device. Device must be connected prior to running this command.

stealCordova.ios.emulate

stealCordova.ios.emulate() -> Promise

Call to start an iOS emulator running your application. Promise will resolve after the application has booted.

Configuration

CordovaOptions

Supports same options as node-webkit-builder, but at minimum needs:

buildDir

id

name

platforms

License

MIT