This documentation relates to previous versions of Titanium.

To see the latest documentation, visit docs.appcelerator.com.

Skip to end of metadata
Go to start of metadata

Welcome to Titanium! You're probably anxious to get started, so we'll dive straight into the basic steps necessary to get started developing apps:

System Requirements

 Expand for the recommended minimum system requirements for Titanium

A system must satisfy the following requirements in order to run Titanium successfully.

Memory

Product

Host Operating System

RAM

Titanium Studio

All

1GB (contiguous)

Latest Android SDK

OS X

1.5GB (contiguous)

Latest Android SDK

Windows

1GB (contiguous)

Latest Android SDK

Ubuntu

1.5GB (contiguous)

As a general rule, 2 to 3GB RAM is usually adequate to run the whole Titanium environment.

Operating System

Titanium is only supported when run on the following Operating Systems:

Operating System

Min Version

Max Version

Apple Mac OS X

10.6.X (Snow Leopard)

10.7 (Lion)

Windows XP (all editions, except Starter Edition)

Service Pack 3

Latest

Windows 7

All

Latest

Ubuntu Linux

10.04 LTS (Lucid Lynx)

11.10 (Oneiric Ocelot)

Windows Vista, NT, 98 and 95 are not supported.

Mobile SDK Installation and Configuration

Since Titanium Mobile enables the development of native mobile applications with a vast array of native functionality built right in, we require the native tool chains for each of the mobile platforms you're targeting to be installed. Follow the steps below to set up your local development environment for the platforms you plan on targeting. If you're just going to be developing for desktop, you can skip right to

installing and configuring Titanium Studio

.

Installing development tools for iOS

 Expand for iOS installation and configuration instructions

To develop iOS applications for Apple devices, such as the iPhone and iPad, you will need to have an iOS developer account. The account is free, but to run on device you will need to sign up for the iOS Developer Program costing $99/year. Also be aware of Apple's license terms, which prohibit the building and execution of iOS applications on anything other than Apple hardware.

Xcode and iOS SDKs

Titanium requires Xcode and the iOS SDKs to be installed in order for you to develop iOS applications. Unless you intend to write applications exclusively for Android products, you should install these components.

There are two ways to obtain Xcode, the application that installs and manages iOS SDKs:

  1. launch the App Store application, found in the Applications folder, and search for and install "xcode" (includes only currently-supported iOS SDKs)
  2. enroll with the Apple Developer website, and browse the iOS Dev Center page to manually download the Xcode Install Assistant Installer (includes all previously-released iOS SDKs, new and old)

Both of the above options are currently free of charge, although may require credit card details to be entered. If you wish to test your applications on a device, however, you will need to become a member of the iOS Developer Program, by way of an annual subscription charge of $99 at the time of writing.

See Installing and Updating iOS SDK for detailed instructions about how to install, including the program location and system environment variables that should be used.

Installing development tools for Android

 Expand for Android installation and configuration instructions

Android SDK Manager and Packages

Titanium requires the Android SDK to be installed in order to allow you to develop Android applications. Unless you intend to write applications exclusively for Apple products, you should install this component.

Remember that Oracle JDK is a prerequisite for Android development, and so should be installed first. See Installing Oracle JDK for instructions.

The Android SDK Manager installer may be obtained from the Official Website

See Installing and Updating Android SDK for detailed instructions about how to install, including the program location and system environment variables that should be used.

Android SDK Packages

When the Android SDK Tools has been installed, and you can run the android executable to invoke the Android SDK Manager.

Refer to Installing and Updating Android SDK for detailed instructions about how to install, including the program location and system environment variables that should be used.

Installing development tools for BlackBerry

 Expand for BlackBerry installation and configuration instructions

Currently, BlackBerry development support is only available for Pro and Enterprise subscribers. Our best and most recent installation documentation can be found as a part of the main Titanium Studio documentation here. BlackBerry development requires use of a Windows-based PC.

Installing and Configuring Titanium Studio

Now, we should be all set to install the Integrated Development Environment used to develop Titanium applications - Titanium Studio. Through the Titanium Studio tool, you will create, manage, and deploy Titanium desktop and mobile applications. The Titanium Studio installer for your platform is downloadable from http://my.appcelerator.com - be aware that in order to access this page and log in to the Titanium Studio development environment, you will require a valid Appcelerator Network account. If you do not have one, you can sign up for one here.

 Expand for more Titanium Studio installation instructions

Further support for installing and configuring Titanium Studio can be found in its dedicated wiki space here.

Download and install Titanium Studio

After downloading the installer for your platform, open the file and follow the onscreen instructions to complete the Titanium Studio installation. After a simple installation process, the Titanium Studio application should be available on your computer.

When you launch Titanium Studio for the first time, you will be prompted for your Appcelerator Network username and password. This is only necessary on first launch of the software. You will also be prompted to select a "workspace" - a workspace is just a folder where Titanium Studio will place all of your project files and your IDE preferences data for your current workspace.

If you see the error, "Could not locate the Android SDK at the given path", when configuring the Android SDK Home field in Preferences > Titanium Studio > Titanium, confirm that you have all the prerequisite packages installed, as shown in the Summary of Installed Android Packages screenshot.

If this issue persists, install the latest Continuous Build, ensuring that you choose the master branch from the drop-down menu of the download site. Then restart Studio and try again. Note that you do not have to actually use this version of the SDK for your apps; it simply needs to exist on your system.

(Android Only) Configure Android SDK for Titanium Studio

Once Titanium Studio has launched, you will need to configure your Android SDK settings in order to develop mobile applications on that platform. To configure your Android SDK, visit the "Preferences" window and select "Titanium" under "Titanium Studio". Here, you must choose an Android SDK directory Titanium Studio will use to run the Android emulator and other Android build tooling.

Hello World!

Now after all that tedious downloading and configuration, it's time to write some code! At this point you are encouraged to try creating and running one of each of the project types listed below:

Titanium Mobile "Hello World"

 Expand for instructions on running "Hello World" for Titanium Mobile

Titanium Studio gives you a couple of ways to start a new mobile project. If you're the menu type, choose File, New Project. If toolbars are more your thing, click the New Project button at the left end of the toolbar. Either way, choose Titanium Mobile Project and the following dialog box will be displayed.

Of course, yours will be empty to start. Every project requires these details:

  • A project name – this will become your app's name as seen by users, so choose wisely.
  • App Id – Titanium's version of the Android Package Name or CF Bundle Identifier. Typically, you enter a name in reverse domain name format with your app's name at the end. Avoid spaces and special characters. More details on the app ID are covered in the Deployment & Distribution chapter.
  • Company/Personal URL
  • Titanium SDK Version
  • Deployment Target – you can create a single project to target Android, iPhone, and iPad

Once this is complete, Studio creates a starting project file set for you.

  • Resources folder – your project's code files and graphics are stored in this folder
  • app.js – your project's bootstrap file. Every project has one; it's the file loaded first when your app is launched
  • tiapp.xml – The details you enter in the new project wizard are used to populate the tiapp.xml file and the manifest file.

Those are basically the only required files. You can create others. For example, you don't have to put all of your code into app.js. (Later in this guide, we'll show one method for dividing up code into multiple files.) You could put all your graphics in the Resources directory, or you could put them into subfolders. We'll dig more deeply into cross-platform development later, but the android and iphone directories within Resources are locations for your platform-specific assets.

Titanium Desktop "Hello World"

 Expand for instructions on running "Hello World" for Titanium Desktop

To create a Titanium Desktop application in Titanium Studio, select "File > New > Titanium Desktop Project" in the menu bar. When creating a new desktop project, you will need to give it a name, an app ID, and a company URL. You can also select a language module like PHP, Ruby, or Python at project creation time as well.

Once your Titanium Desktop project has been generated, take note of two important components - the first is tiapp.xml, which is located at the top level of your new project directory. The second is the Resources directory, which functions as the logical web root within the navigation. The default project has a very simple index.html, which serves as the entry point to our Desktop application:

index.html

In the App Explorer view, choose to run your new application as a desktop application!

When running, your new application should look a little bit like:

Running your app

To build and run your app, simply click the Run button as shown in the following graphic. Then, choose the appropriate target.

Your app should now be running in a mobile OS simulation environment.

 Click here to expand...

Troubleshooting

If you are experiencing problems after following these setup instructions, please see our comprehensive Titanium 3-Step Setup collection of guides.

Next Steps

Congratulations! You've just created and ran your first Titanium application. Now it's time to get serious about getting serious - you'll likely want to visit our In-Depth Reference Guides section next to train up on the key concepts and core APIs you will need to write professional Titanium applications. You'll also want to check out our Example Applications to get a sense of what Titanium can do. Finally, you'll probably want to check out our Videos to stay on top of the latest and greatest Titanium development tips and tricks.

Thanks for checking out Titanium!

Labels
  • None