Skip to content

Latest commit

 

History

History
148 lines (108 loc) · 8.03 KB

ALLOY_README.md

File metadata and controls

148 lines (108 loc) · 8.03 KB
Raw

Alloy

Build Status Dependency Status devDependency Status NPM version

NPM

Alloy is an MVC application framework by Appcelerator for Titanium. More high-level details can be found here: http://www.appcelerator.com/platform/alloy/

Getting Started

Installation

from npm:

# install the latest stable
[sudo] npm install -g alloy

# install a specific version
[sudo] npm install -g [email protected]

# install cutting edge directly from github
[sudo] npm install -g git://github.com/appcelerator/alloy.git

from Titanium Studio

...oh yeah, Studio will do it for you automatically. :)

Running Sample Test Apps

Alloy includes many sample and test apps in the test/apps folder (see above). For example, basics/simple or models/todo. You can run these in a few different ways:

A) With a regular Alloy installation

Beginning with Alloy 1.6, you can do the following:

# first, create a Titanium Classic project
titanium create --name yourAppName
cd yourAppName

# then, convert it to an Alloy project, using the test app as a template
alloy new . --testapp basics/simple

B) By cloning the repo and using the Jake test runner

# first, clone the repo
git clone https://github.com/appcelerator/alloy.git
cd alloy

# install jake globally
[sudo] npm install -g jake

# install alloy globally from the cloned repo
[sudo] npm install -g .

# install alloy's local testing dependencies
npm install

# run a test app
jake app:run dir=basics/simple

C) Importing the "Harness" to Titanium Studio

You can use these apps through Titanium Studio too. The easiest way to do that would be to import the test/project/Harness into Titanium Studio. After that, everytime you run jake, your project in Studio will be updated. Once in Studio, you can run for any platform, Titanium SDK version, or change any settings you want. This will give you a lot more options and power than running solely from the command line.

Additional Notes on Jake

  • See the jake readme for information on using jake including the arguments and flags it accepts.
  • on OSX or Linux
    • Try using sudo with the jake command if you run into permission errors.
  • on Windows
    • Don't run jake from within a user folder (i.e. C:\Users\tony\alloy), as you can get all kinds of non-obvious permissions failures from the child processing Alloy does. Your safest bet is to just git clone right to C:\alloy.
    • Node.js has an issue piping output between node processes on Windows. I've tried to workaround as best I can. You may still see errors pop up, so it's suggested that if you run the automated testing via jake test:all or npm test, you do so on a non-Windows OS to ensure there's no red herring failures until the aforementioned node.js issue is resolved.
    • If you decide to ignore my advice and run the tests anyway on Windows, make sure that if you imported the Harness into TiStudio that you don't have TiStudio running. Windows creates locks on key files in that project that are necessary for the testing process. It will make tests fail erroneously.
    • If you're still that stubborn, are running the test suite on Windows, and you're getting those intermittent, erroneous errors, try running them one spec at a time. Instead of doing jake test:all, do jake test:spec[SPEC_NAME], where SPEC_NAME is JS file in the test specs folder.

Feedback

More so than any other Appcelerator project to this point, we are working collaboratively with the community to develop a framework that works for you. Here's the best ways to discuss Alloy or ask questions.

  • Got an Alloy development question? Go to the Appcelerator Q&A, and make sure to use the alloy tag.
  • Want to discuss the past, present, and future of Alloy? Join the Alloy Google group.
  • Got a confirmed bug? Log it at the Titanium Community Issue Tracker. Make sure to give it the alloy label.

Other than that, all the usual rules for submitting feedback apply. The more code, details, and test cases you provide, the easier it will be to act on that feedback.

Contributing

Alloy is an open source project. Alloy wouldn't be where it is now without contributions by the community. Please consider forking Alloy 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 Alloy 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.

Contributors

 project  : alloy
 repo age : 2 years, 4 months
 active   : 589 days
 commits  : 3168
 files    : 2687
 authors  :
  2363	Tony Lukasavage        74.6%
   312	Tim Poulsen            9.8%
   106	Feon Sua               3.3%
    87	Jeff Haynie            2.7%
    75	Russ McMahon           2.4%
    38	Kevin Whinnery         1.2%
    36	Ben Hatfield           1.1%
    32	Fokke Zandbergen       1.0%
    21	Carl Orthlieb          0.7%
    11	Paul Mietz Egli        0.3%
     8	Issam Hakimi           0.3%
     7	Chris Barber           0.2%
     6	Praveen Innamuri       0.2%
     6	Arthur Evans           0.2%
     5	David Bankier          0.2%
     5	Xavier Lacot           0.2%
     4	Martin Tietz           0.1%
     4	Joel Herron            0.1%
     3	Ingo Muschenetz        0.1%
     3	Federico               0.1%
     2	Tim Statler            0.1%
     2	Iain Dawson            0.1%
     2	Bryan Hughes           0.1%
     2	Marc Tamlyn            0.1%
     2	miga                   0.1%
     2	Davide Cassenti        0.1%
     2	Aaron Saunders         0.1%

Legal

Alloy is developed by Appcelerator and the community and is Copyright (c) 2012 by Appcelerator, Inc. All Rights Reserved. Alloy is made available under the Apache Public License, version 2. See the LICENSE file for more information.