pkdevboxy / cordova-osx

Mirror of Apache Cordova mac

Cordova OSX

CordovaLib is a framework that enables users to include Cordova in their OS X application projects easily, and also create new Cordova based OS X application projects.

Note that the current focus of this cordova platform is to provide kiosk-like applications for OSX, that usually run fullscreen and have little desktop interaction. So there is no direct support for menus, dock integration, finder integration, documents, etc. Think of it as a mobile app running on a very big screen.

Pre-requisites

Make sure you have installed the latest released OS X SDK which comes with Xcode 6 or later. Download it at http://developer.apple.com/downloads or the Mac App Store.

Use Development versions for your build

Since OSX is not officially released yet, we need to use the development versions of the respective modules where OSX was already added. currently those are:

• cordova-lib
• cordova-plugman
• cordova-plugin-file

1. checkout the master branch of cordova-lib, cordova-plugman, cordova-cli and all the plugins you require

2. link the development version if cordova-lib to cordova-cli and cordova-plugman (see https://github.com/apache/cordova-lib#setup)

   $ cd cordova-lib/cordova-lib
   $ npm install && npm link
   $ cd ../../cordova-cli
   $ npm link cordova-lib && npm install 
   $ cd ../cordova-plugman
   $ npm link cordova-lib && npm install
   

Create your project

1. (Optionally) Follow the instructions in the Command-Line Usage section of the Cordova Docs to create a new project. For example

   $ cordova create hello com.example.hello HelloWorld
   

2. add the osx platform:

   $ cordova platform add osx
   $ cordova run osx
   

3. You can also open the project in XCode:

   $ open platforms/osx/<yourproject>.xcodeproj
   

Add plugins

1. if you need the file-plugin add the master branch version, eg:

   $ cordova plugin add https://github.com/apache/cordova-plugin-file.git
   

Create a Cordova OSX Standalone project

1. Download the source

2. execute the create command to setup an empty project:

   $ bin/create <path_to_new_project> <package_name> <project_name>
   

   for example

   $ bin/create ../Foo org.apache.foo FooBar
   

Add plugins

1. if you need the file-plugin add the master branch version, eg:

   $ cordova plugin add https://github.com/apache/cordova-plugin-file.git
   

Updating a CordovaLib subproject reference in your project

When you update to a new Cordova version, you may need to update the CordovaLib reference in an existing project. Cordova comes with a script that will help you to do this.

1. Launch Terminal.app
2. Go to the location where you installed Cordova, in the bin sub-folder
3. Run update /path/to/your/project

FAQ

How do debug the webview?

You need to enable the WebDeveloperExtras for your bundle:

defaults write com.yourcompany.yourbundleid WebKitDeveloperExtras -bool true

After you changed the defatuls, start the application and right-click inside the webview and select Inspect Element. This opens the Safari Developer Tools.

Note: The bundleid is usually the same as your widget id you define in your config.xml unless overridden by the ios-CFBundleVersion argument.

BUGS?

File them at the Cordova Issue Tracker

MORE INFO

• http://cordova.apache.org/