The App Development Starter Kit was developed to allow you to create apps using the same tools that CA Agile Central uses internally. For more information on the basics of app development see Getting Started.
java (required for jslint support; recommended)
Ensure java is included in the global PATH.
http://rubyinstaller.org/downloads/ (Windows only- comes with OSX)
The starter kit has been tested against v1.8.7 of ruby.
Rake is a build tool for ruby and can be installed from the command line:
> gem install rake
Download and uncompress the starter kit from the link located at the bottom of this page.
The starter kit contains the following items:
- Examples: Example apps that can be built using the toolkit
- lib: New app templates and the jslint4java jar file
- Rakefile: Contains targets for building apps
The rakefile is used to manage all parts of the app development process. The following targets are defined:
Create an App
This task creates a new directory with an html, css, and js file for app development.
> rake new[AppName] Creating directory AppName... Creating AppName.css... Creating AppName.js... Creating AppName.template.html...
Note that in order to support running outside of CA Agile Central, the SDK is included as a fully qualified URL from rally1.rallydev.com. On-premises users should adjust the template.html file to reference the correct server. More information on using apps outside of CA Agile Central can be found here.
Also note that the SDK is included in debug mode for development (?debug=true). More information on SDK query string parameters can be found here.
> rake jslint Running jslint... -------JSLint output for AppName.js-------------- jslint:AppName.js:3:10:Missing semicolon.
Deploy To CA Agile Central
Once development and debugging is complete it is time to combine the html, css, and js files into one html file which can be easily pasted into a CA Agile Central custom tab.
> rake combine Processing AppName.template.html... Concatenating AppName.css... Concatenating AppName.js... Creating merged app html file AppNameApp.html... AppNameApp.html successfully created!
Alternatively, you can invoke the deploy target. This is the same as combine but also runs jslint. This is also the default and can be invoked by typing rake.
> rake deploy Running jslint... -------JSLint output for AppName.js-------------- Processing AppName.template.html... Concatenating AppName.css... Concatenating AppName.js... Creating merged app html file AppNameApp.html... AppNameApp.html successfully created!
Paste the contents of the generated App.html file into a custom tab to begin using it in your CA Agile Central workspace.
Note that the generated App.html file no longer references the App SDK using a fully qualified URL and so can no longer be run outside CA Agile Central. Instead, the SDK will be loaded from the CA Agile Central server in which the app is running.