Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Setup iOS Development Environment

Status
colourYellow
titleThis documentation is outdated and is currently being updated.
Requirements

  1. Apple OSX development environment.
  2. Download XCode 4.6.
  3. Download PhoneGap 2.50.
  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.

...

  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 AndroidiOS 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:
     

...

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 6.1 Simulator and run the project!
    Image Removed

    Image Added

uMobile Screen Shots

Gallery
includeum-dashboard.png, um-login.png, um-map.png, um-dining.png, um-laundry.png
columns3
titleuMobile Screen Shots

Debugging

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