steverhoads/ts-app-builder

A starting place for apps the Tech Services Team writes, including stubbing out for Jasmine Tests.

#Tech Services App Builder This app builder will create a new space for you, setting up necessary structures for testing and development. It'll create a structure that provides:

• src/javascript: All the JS files saved here will be compiled into the target html file
• src/style: All of the stylesheets saved here will be compiled into the target html file
• test/fast: Fast jasmine tests go here. There should also be a helper file that is loaded first for creating mocks and doing other shortcuts (fastHelper.js)
• test/slow: Slow jasmine tests go here. There should also be a helper file that is loaded first for creating mocks and doing other shortcuts (slowHelper.js)
• templates: This is where templates that are used to create the production and debug html files live. The advantage of using these templates is that you can configure the behavior of the html around the JS.
• config.json: This file contains the configuration settings necessary to create the debug and production html files. Server is only used for debug, name, className and sdk are used for both.
• package.json: This file lists the dependencies for grunt

#Installing

1. Install node.js This really is as simple as going to node[node] and pushing the Install button. Afterward, type this command to see that it installed:

   npm --version
   

2. Install grunt From the command line, use the node package manager to install grunt. On linux/mac, you might have to use sudo as shown below. On Windows, you will not use the sudo part of the command.

   sudo npm install -g grunt-cli
   sudo npm install -g grunt-init
   

3. Install template The easiest thing is to install this template to your home directory:

   git clone https://github.com/RallyTechServices/ts-app-builder.git ~/.grunt-init/ts-app-builder

(Windows users, see [the documentation][grunt-init] for the correct destination directory path)

4. Create

When 1-3 are done, you can do this step in as many different places as you like.

Create a new directory for your app, cd into that directory, then type:

grunt-init ts-app-builder

You'll be prompted for some default values. You can change them in teh resulting config.json and auth.json files.

After the prompt comes back, do a local install by typing (ignore warnings about missing repositories):

npm install

After install is complete, you should be able to run the fast tests and get one success and one failure. Something like this:

Running "jasmine:fast" (jasmine) task
Testing jasmine specs via phantom
x.
Example test set:: should be a failing test: failed
  Expected 0 to equal 1. (1)
2 specs in 0.002s.
>> 1 failures
Warning: Task "jasmine:fast" failed. Use --force to continue.

Another check: You should be able to compile the debug version and view it (after logging in to Rally) in a new tab.

grunt debug

Usage of the grunt file

##Tasks

grunt debug

Use grunt debug to create the debug html file. You only need to run this when you have added new files to the src directories.

grunt build

Use grunt build to create the production html file. We still have to copy the html file to a panel to test.

grunt test-fast

Use grunt test-fast to run the Jasmine tests in the fast directory. Typically, the tests in the fast directory are more pure unit tests and do not need to connect to Rally.

grunt test-slow

Use grunt test-slow to run the Jasmine tests in the slow directory. Typically, the tests in the slow directory are more like integration tests in that they require connecting to Rally and interacting with data.

-- [grunt-init]: http://gruntjs.com/project-scaffolding [node]: http://nodejs.org/