Setup iOS Development Environment

Requirements

1. Apple OSX development environment.
2. Download XCode 4.6.
3. Download PhoneGap 12.7050.
4. Download & run uMobile 1.1RC1 quickstart.
5. Download & install node.
   
   1. Node is used to automate the build process for our JavaScript, HTML and CSS assets.
   2. Node is installed locally and is leveraged for convenience.
   3. Node v0.8.12 is recommended for this documentation.

Getting Started with iOS

The PhoneGap website has an excellent iOS start up guide. It is recommended but not mandatory that you walk through their startup guide before continuing to familiarize yourself with the overall process.

Creating the Project

...

Extract PhoneGap

1. Navigate to the folder where you downloaded PhoneGap 2.50. Find the phonegap-2.5.0.zip file and extract its contents.
2. Expand this folder and navigate to phonegap-2.5.0 > lib > ios directory.
3. The ios directory is where we will be working to create a new project.

Open Terminal

1. Open a new Terminal window.
2. In the Terminal window, navigate to the ios > bin directory from the extracted PhoneGap code base.

Create a Project from the Terminal

There are 3 ordered, required parameters for creating a project from the command line. For more detailed information on these parameters visit the PhoneGap iOS start up guide.

1. Project Location: This is the directory where the Xcode project and files for the application will be located.
2. Package Name: This is the reverse domain name App ID that is created via the Apple Provisioning Portal. Note: The package name is specific to your institution.
3. Project Name: This is the name of the actual project.

To create a project

1. In the Terminal window with ios > bin as your current directory, enter the 3 required parameters with the create command.

   Code Block
   ./create ~/Documents/umobile-phonegap-ios org.jasig.umobile.phonegap.ios

2. Check: Use Automatic Reference Counting
 Image Removed
3. Choose a location for your project.
    Image Removed
4. Disable Automatic Reference Counting in the build.
   
5. Select uMobile under Targets in the main project view.
6. Click on the Build Settings tab.
7. Make sure the All and Combined filters are selected.
8. Search for reference in the search bar.
Set the Objective-C Automatic Reference Counting property to No.
Image RemovedCheck the uMobile source out into the new project directory

uMobile

9. A complete and ready to launch project will be created under the directory specified.
   Image Added 
10. Navigate to the www directory. Open the directory and delete all of the folder contents. Do not delete the www directory itself. The www directory is the folder that houses our custom HTML, CSS and JavaScript implementation. In this step, we are simply removing stubbed files provided by the PhoneGap code base.

Adding the uMobile Source

1. In a Terminal window, navigate to your project location. For this tutorial, our project is housed under the Documents > umobile-phonegap-ios directory.

2. From this directory, checkout the uMobile source code.
   

   Code Block
   git clone git@github.com:Jasig/umobile-app-phonegap umobile-ui

3. Your project directory should look similar to the below graphic:
   Image Added

Configure the uMobile Source

Install Dependencies

1. In a Terminal window, navigate to your project location. For this tutorial, our project is housed under the Documents > umobile-phonegap-iosCopy the iPhone-specific Cordova Javascript file to "cordova.js" directory.
2. In the same Terminal window, navigate to the umobile-ui directory.

3. Execute the following command to load all the ui dependencies. Note: Node must be installed.

   Add SessionTracking Plugin files into the Plugins folder: SessionTracking.h and SessionTracking.m
   Configure www/config.js.  If you're working with the quickstart, set the value of config.uMobileServerUrl to http://localhost:8080.
   Overwrite the file /Classes/MainViewController.m with this one: MainViewController.m

   Code Block
   cd umobile-ios cp www/lib/external/cordova-iphone-1.7.0rc1.js www/lib/external/cordova.js

4. Open the coned GitHub clone in Finder, then drag the www folder into the top of the XCode project with your mouse.
   Image RemovedImage Removed

5. Configure cordova.plist by setting OpenAllWhitelistURLsInWebView to true.  Next, add the hostname of your uMobile server, any authentication server, and any other servers hosting uMobile resources to ExternalHosts.  If you're working with the uMobile application server quickstart, you can simply add localhost to the list. Under Plugins add Key: SessionTracking, String: SessionTracking.

   Image Removed

6. sudo npm install

Configure Authentication

1. uMobile currently supports three different authentication strategies: CAS, Local & Mock.
   
   1. Each strategy has a cooresponding configuration file under the umobile-ui/config/js directory (i.e., cas.js, local.js and mock.js).
   2. Choose one of the three authentication strategies. For this documentation, we will use local.js.
   3. Open local.js.
      
      1. Set config.uMobileServerUrl to http://localhost:8080.
         
      2. Set config.loginFn to localLogin.
         

Configure Build Process

1. Navigate to the umobile-ui/config directory.
2. Open the config.json file in an editor of your choice.

3. Set the external property to the path of your root project's www file directory. See the below code snippet for an example. The external property tells the build process where we want to push production-ready code. In this instance, we are telling it to place our production-ready code in the www container provided by the PhoneGap code base. Note: It is important to point out that while we have the capability to push production-ready code to an external source, we do not have the ability to clean or remove previously pushed code that lives outside of the umobile-ui directory. This is a limitation of the grunt libraries being leveraged on this project. Future updates to this code base could improve this functionality.

   Code Block
   { "port": 5000, "environment": "web", "auth": "mock", "mode": "dev", "less": { "dest": "./src/css", "src": "./src/less", "prefix": "/css", "debug": true }, "external": "../www" }

Run the Build

1. In a Terminal window, navigate to the umobile-ui directory.

2. Execute the below command in the Terminal window.

   Code Block
   grunt prod --environment=ios --auth=local

3. The above command starts the build process for the uMobile source code. The build process configures the uMobile source code with the necessary dependencies needed to run in a given environment. Currently, the uMobile project supports Android, iOS and Web platforms. Once the build completes a www directory will be added to the umobile-ui directory. The www directory houses the production-ready code base to be used with the PhoneGap wrapper. Please see the documentation on the uMobile HTML5 build for more information on configuring the build script.

4. Once built, execute the below command to push the built code to the PhoneGap www directory.

   Code Block
   grunt push.prod

5. Your project directory should like similar to below graphic:
   Image Added 

Add uMobile Icons and Splash Screens

The uMobile source code ships with iOS icons and splash screens. Currently, these splash screens and icons have not been designed for the new high-retina displays. Future work on the uMobile source code should focus on updating these icons and splash screens for high-retina displays.

1. In the Finder, navigate to your project location. For this tutorial, our project is housed under the Documents > umobile-phonegap-ios directory.
2. All icons and screens can be found at the following path: umobile-phonegap-ios > src > images > platform > ios
3. Update the images within the ios folder to match your organization or institution.
4. Copy all the icons from ios directory to the umobile-phonegap-ios > uMobile > Resources > icons directory.
5. Copy all splash screens from the ios directory to the umobile-phonegap-ios > uMobile > Resources > splash directory.

Start the uMobile Server

1. The requirements section of this documentation states that you need to download and start the uMobile quickstart (i.e., uMobile 1.1RC1). The uMobile quickstart houses all the content leveraged by the uMobile application for this tutorial. For more information on the uMobile quickstart visit the project's main site.

2. Once the uMobile server is downloaded and extracted. Navigate to the root folder and execute the following command:

   Code Block
   ant start

Run uMobile with the iOS Simulator

1. In Finder, navigate to your project location. For this tutorial, our project is housed under the Documents > umobile-phonegap-ios directory.
2. Double click the uMobile.xcodeproj file. This will open the xCode editor.
   
3. Set the scheme at the top of the project to iPhone 56.1 Simulator and run the project!
   
   Image Added
   

uMobile Screen Shots

Debugging

uMobile logs helpful events and errors.  You You can access the log by viewing the console output.