Skip to content

caffeinalab/titanium_mobile

 
 

Repository files navigation

Titanium

Welcome to the Titanium open source project. Titanium provides a mature platform for developers to build completely native cross-platform mobile applications using JavaScript.

Currently supported native platforms are iOS, Android and Windows Phone / Windows Desktop.

Titanium is licensed under the OSI approved Apache Public License (version 2). Please see the LICENSE file for specific details.

Download Pre-built Titanium

Table of Contents

  1. Features
  2. Hyperloop
  3. Alloy
  4. Getting Help
  5. Contributing
  6. Building Locally
  7. Legal Stuff

Features

With Titanium, you use JavaScript to code your application. Titanium's compiler will compile your application code into an efficient native executable for each target mobile platform.

  • Native apps built using JavaScript (no hybrid, no embedded WebView)
  • Apps are compiled and run locally with full offline support
  • Support for native platform UI controls (TabGroup (iOS), ActionBar (Android), AppBar (Windows), ...)
  • Support for watchOS targets
  • Support for in-application SQL database
  • Support for Geolocation (compass, geolocation, forward/reverse lookup)
  • Support for Camera (taking Photos, playing and recording Video)
  • Support for Calendar (creating & fetching Events)
  • Support for 3D-Touch (Peek and Pop, Application Shortcuts, ...)
  • Support for Photo Album (reading and writing)
  • Support for Contacts Database / Address Book
  • Support for Streaming Audio and Recording Audio, Audio Input Levels, Mic etc
  • Support for Vibration
  • Support for Social APIs such as Facebook, Twitter, etc.
  • Support for Yahoo YQL
  • Support for Web Services via REST, SOAP
  • Support for native Maps
  • Support for Push Notifications
  • Support for In-Application Email
  • Support for In-Application SMS, Telephone
  • Support for Filesystem (create, read, write, etc.)
  • Support for Gestures (such as Shake and Pinch)
  • Support for Platform and Device capabilities
  • Support for complex native views such as Coverflow, Image Views, Table Views, Grouped Views, Composites, etc.
  • Support for Web Views incorporating HTML5, CSS etc.
  • Completely extensible via Module API and Hyperloop for building your own controls or extending capabilities

And much, much more (see our Documentation for more infos).

Hyperloop

Use Hyperloop, our latest addition to the Appcelerator Platform, to extend your Titanium apps by native API's using JavaScript. Prior to Hyperloop, you would use native modules to extend the Titanium API. With Hyperloop, you are now able to implement native classes, 3rd-Party libraries (Cocoapods, local frameworks, .aar files) and more directly into your apps. Hyperloop is available for iOS, Android and Windows Phone (Tech Preview).

Features

Cross-Platform Reuse

Build and maintain apps in a fraction of the time with up to 95% code reuse.

Direct API Access

Access 100% of platform APIs directly, with instant support for each new OS release.

JavaScript Everywhere

Create mobile apps using the world’s most popular programming language.

3rd-Party Libraries

Incorporate 3rd-party native libraries using JavaScript, with no changes required.

Custom Animations

Easily create complex custom effects like dynamic animations using JavaScript.

Run Native

Mobile app development for every major mobile OS – with no hybrid compromises.

Example

Create a native view in iOS, Android and Windows Phone:

// iOS
var view = new UIView();

// Android
var view = new View(activity);

// Windows Phone
var view = new Canvas();

Getting Started

Check out our Hyperloop Sample App and Hyperloop Programming Guide to get started with Hyperloop today!

Alloy

Alloy is the MVC application framework built on top of Titanium. It is optional. It rocks. Check it out if you're considering using Titanium. It is also a separate open source project available under Apache Public License.

Example

Manage your application scope by separating your code into different models, views, controllers and more:

index.xml (View)

<Alloy>
  <Window title="Titanium and Alloy">
    <Button onClick="handleClick" id="myButton">Click me!</Button>
  </Window>
</Alloy>

index.js (Controller)

function handleClick() {
  alert('Hello from the Controller!');
}

index.tss (Style)

Window: {
  backgroundColor: 'white'
}

"#myButton": {
  width: 200,
  height: 30,
  backgroundColor: 'green'
}

Getting Help

There are a number of ways to get help with Titanium.

Official Documentation, Tutorials and Videos

Please visit the official documentation site at http://docs.appcelerator.com/ for the latest and historical documentation on Titanium, Alloy and the various products built by Appcelerator.

Developer Community

Appcelerator Developer is our developer community.

Video Tutorials

Appcelerator University is our main video channel for video tutorials on Titanium.

Slack

Community support and discussion about Titanium is available on Slack at TiSlack.

Twitter

Please consider following @Appcelerator and @AppcDev on Twitter for updates.

Blog

The Appcelerator blog is located at (http://www.appcelerator.com/blog).

Commercial Support, Licensing

We give our software away for FREE! In order to do that, we have programs for companies that require additional level of assistance through training or commercial support, need special licensing or want additional levels of capabilities. Please visit the Appcelerator Website for more information about Appcelerator or email [email protected].

Contributing

Titanium is an open source project. Titanium wouldn't be where it is now without contributions by the community. Please consider forking Titanium to improve, enhance or fix issues. If you feel like the community will benefit from your fork, please open a pull request.

To protect the interests of the Titanium contributors, Appcelerator, customers and end users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is simple and straightforward - it requires that the contributions you make to any Appcelerator open source project are properly licensed and that you have the legal authority to make those changes. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes only a few minutes, and only needs to be completed once.

You can digitally sign the CLA online. Please indicate your email address in your first pull request so that we can make sure that will locate your CLA. Once you've submitted it, you no longer need to send one for subsequent submissions.

Building Locally

Previously Titanium used scons and python scripts to build the SDK. If you'd like to build the SDK locally, we've replaced scons with some Node.JS scripts. Typical usage would be:

npm install
cd build
node scons.js cleanbuild --android-ndk /opt/android-ndk --android-sdk /opt/android-sdk

The build and package commands will default to all target platforms on your host OS unless explicitly specified. (i.e. Android, iOS on macOS; Windows and Android on Windows). It will compile, package and install the locally-built SDK for you as well, so you can test it in your own applications without any further procedures.

The build command will look for Android NDK and SDK using $ANDROID_NDK and $ANDROID_SDK env variables if not explicitly passed using command line arguments.

You can use the -h flag to display the full list of comands and options.

npm install
cd build
node scons.js cleanbuild [platform1] [platform2] --android-ndk /opt/android-ndk --android-sdk /opt/android-sdk /Users/build/android-sdk-macosx

Unit tests

We have a common unit test suite intended to run across all supported platforms.

To invoke the tests, you must create a local build of the sdk via the steps above and have an sdk zip in your dist directory. Then you'd run:

cd build
node scons.js test [platform]

How it works

The common test suite generates a single titaniun project targeting the specified platform, builds the project for emulator, launches the app on the emulator and then runs a series of tests defined via ti-mocha and should.js.

The tests spit out their results to the console log, and the test scripts listen to the logs to gather the results. We then generate an overview on the console as well as a junit report xml file (to be consume by CI build systems like Jenkins).

How to modify the tests locally and in your PRs

The tests folder acts as an override folder for the common suite. Any files living within that directory are copied on top of the common suite's app structure.

Adding a new test suite

In practical terms that means if we need to add new test files, you'd place the new file under tests/Resources, and then copy the titanium-mobile-mocha-suite/Resources/app.js to tests/Resources/app.js and editing the copy to require the new file(s).

For example, if we want to test a new Ti.Foo namespace, we'd create a new test file at tests/Resources/ti.foo.test.js. We'd then copy titanium-mobile-mocha-suite/Resources/app.js to tests/Resources/app.js and add the line:

require('./ti.foo.test')
Editing an existing test suite

If we want to edit the set of tests for the Ti.App namespace, we'd copy the existing test from titanium-mobile-mocha-suite/Resources/ti.app.test.js to tests/Resources/ti.foo.test.js. We'd then edit the file to add/remove/modify the existing suite.

Merging the modified tests back to the common suite

We do not have any automated process for merging the modified tests from the tests override folder back to the common unit test suite.

As a result, we need to manually 'migrate' the modified files back to the suite ourselves. This involves copying the modified folders to a clone of that repository on the same mainline branch (i.e. master, 6_1_X, 7_0_X), committing and pushing it up to the common suite; then removing the files from titanium_mobile/tests.

A future improvement could be to modify our Jenkins build in Jenkinsfile to automate this merge back to the common suite if all tests run and pass on a mainline branch.

Legal Stuff

Appcelerator is a registered trademark of Appcelerator, Inc. Titanium is a registered trademark of Appcelerator, Inc. Please see the LEGAL information about using our trademarks, privacy policy, terms of usage and other legal information at http://www.appcelerator.com/legal.

Packages

No packages published

Languages

  • Objective-C 42.4%
  • Java 31.6%
  • JavaScript 18.3%
  • C++ 2.5%
  • C 2.1%
  • HTML 1.3%
  • Other 1.8%