Skip to end of metadata
Go to start of metadata

Quick Start Guide

  1. Clone AUI (fork if you plan to contribute code). Don't play Guess The Repo, follow the link.
  2. Install the Atlassian Plugin SDK (note you do not need to create a hello world plugin, just install the SDK): 
    1. there are platform-specific installers to set up the SDK; or
    2. if you use homebrew see SDK Downloads for the tap details.
  3. Run ./aui.sh install ...the first install will download the interwebs, so grab a snickers.
  4. Run up the refapp: ./aui.sh refapp
  5. See Testing AUI for details on testing requirements.

Now you have a refapp you can view test pages, access a Sandbox and run tests. The refapp URL will be shown in the console, usually localhost:9999/ajs.

Flat pack

If you want to generate your own copy of the flat pack, run ./aui.sh flatpack ...this should take approximately 20-30 seconds, so if you can eat a Snickers in that time I salute you.

You will find the zip and the raw output in /aui-flat-pack/target/ or you can use the ./aui.sh flatpackopen option to automatically open the generated flat pack in your system's default browser.

The long and detailed version

Access requirements

You will need...

  1. A BitBucket account with access to the AUI repo
  2. Access to the AUI Project (for issues and reviews).
  3. Access to edit AUI developer documentation on DAC (if your contribution isn't documented, it doesn't exist!). You may need to do a password reset to get your new DAC password. External contributors can add their draft documentation to the relevant AUI issue.

Editor/IDE

There is no particular editor requirement for AUI. An IDE is not required, although it can make things like running integration tests much easier. Of the Java IDE options we generally use Intellij IDEA. Otherwise use whatever editor you want.

Bash

As with other Atlassian products, you'll be using terminal/shell/bash to run maven commands etc so you'll need to know your way around the command line. On mac, just use Terminal. On Windows, the command prompt will do the job; but for anything more than the minimum you'll find life easier if you install something like Cygwin.

Check out AUI

See AUI source code for, you guessed it, a link to clone/fork the source code. Don't guess the repo, follow the link. Note: while you can clone AUI directly, it is recommended that you do all work on a fork of AUI.

Java, Maven and the REFAPP

See Running the AUI refapp for details.

Installing Browsers

You will need to test your changes or new components using all supported browsers. This is not optional and we know you expect other people to do it with their contributions, so don't cut corners! (smile)

Handy links: Chrome, Firefox, Opera, Safari.

Internet Explorer 8+

Icon

Do not use any "multiple IE" hack as they will eventually hurt you. Use real installations and/or VMs.

For Mac Users

You may find this saves a lot of trouble: https://github.com/xdissent/ievms ...it uses the free testing images provided by Microsoft. While these do expire, the script means you just need download quota and patience (let it run while you watch a movie).

Alternatively you'll need to set up a VM for each supported IE version:

  1. Download and install either virtual box (http://www.virtualbox.org/) or vmware (available on the Atlassian Intranet)
  2. Locate and copy the Windows XP Vmware Image (on the Atlassian Intranet)
  3. Make another copy of this image (for IE8)
  4. Name each image eg "Windows XP IE8"
  5. Open up both images in your vm software and name accordingly
  6. Download and install IE8 on the other VM (if it is not already installed)
For Windows Users

You will need the latest version of IE on your system (note you will need Windows 7 for IE9) and VMs for the other versions:

  1. Download and install a virtual machine solution
    1. Windows 7 users should evaluate XP Mode (note: XP Mode is a full XP instance and must be maintained accordingly including updates, firewall and antivirus). Note you can use differencing to run multiple XP Mode instances for IE 6, 7, 8; but only IE8 is required for AUI testing.
    2. Virtual PC (http://www.microsoft.com/windows/virtual-pc/) and IE testing VMs/images
    3. Virtual Box (http://www.virtualbox.org/)
    4. VMWare (available on the Atlassian Intranet)

For virtual box and vmware:

  1. Locate and copy the Windows XP Vmware Image (on the Atlassian Intranet)
  2. Open up the image rename to "Windows XP IE8"
  3. Download and install IE8 (if it is not already installed)

Running tests

See Testing AUI for details on running tests.

  • No labels