-
Notifications
You must be signed in to change notification settings - Fork 36
Preparing Your Machine for CollaboRhythm Development
The steps below describe the process for preparing a computer for CollaboRhythm development. The steps assume that you are working with a computer running Windows 7 or Mac OS X and that you do not already have any of the prerequisites installed. The tools described here may also work on other operating systems, but have not been tested or documented for other environments. If you do try this on another OS, please feel free to make appropriate additions/corrections to this page.
Also note that these instructions assume that you are completing these steps BEFORE trying to open or work with a copy of CollaboRhythm. If you make any of the changes below after copying and opening CollaboRhythm you may run into problems and will either need to perform additional steps to resolve the problems or you may want to get a fresh copy of CollaboRhythm (discard local changes) after all of the steps specified here have been completed.
-
Download the latest version of IntelliJ IDEA 12.x Ultimate Edition (version 12.0.1 as of January 14, 2013). You must install the Ultimate version, because the Community version does not support Flex/ActionScript development. Note that IntelliJIDEA 12.x Ultimate Edition is a commercial product but a 30 day trial is available, so you should use that. There is a free Open Source Project License available for IntelliJ which CollaboRhythm developers may use. If/when you become a contributor to CollaboRhythm you can request a copy of the license here https://docs.google.com/spreadsheet/viewform?fromEmail=true&formkey=dFNYS0ZMMkJfMTZDbDgwUnBINnZjelE6MQ.
-
Install IntelliJIDEA 12.x
-
Run IntelliJ, It will run an “Initial Configuration Wizard”
a. VCS - disable all except Git.
b. Web/JavaEE Technology Plugins - disable all
c. HTML/JavaScript Dev Plugins - leave them all enabled
d. Maven - disable
e. Other - leave them all enabled
-
Download Git (get whatever version is appropriate for your OS)
-
Install Git and set up Git by following the official guide here: http://help.github.com/win-set-up-git/
-
In IntelliJ, set the location of the Git executable in the Git page of the Settings dialog box
a. File -> Settings
b. Version Control -> VCSs -> Git
c. Specify your "Path to Git Executable". Typical paths for different operating systems: * Windows 64-bit: C:\Program Files (x86)\Git\bin\git.exe * Windows 32-bit: C:\Program Files\Git\bin\git.exe * Mac OS: /usr/bin/git
-
Download the latest Flex SDK version 4.6.0.23201B
http://blogs.adobe.com/flex/files/2012/05/FlexLicense.swf?build=4.6.0.23201B&pkgtype=1
-
Create a directory for the Flex SDK named "4.6.0" in an appropriate location:
- Windows 64-bit: C:\Program Files (x86)\Adobe\Flex\sdks\4.6.0
- Windows 32-bit: C:\Program Files\Adobe\Flex\sdks\4.6.0
- Mac OS: /Applications/Documents/SDKs/4.6.0
-
Unzip the SDK file and place the contents (readme.htm, ant, asdoc, frameworks, etc.) in the directory you created. After copying the SDK files you should have the following:
- Windows 64-bit: C:\Program Files (x86)\Adobe\flex\sdks\4.6.0\readme.htm
- Mac OS: /Applications/Documents/SDKs/4.6.0/readme.htm
-
Download Java SE Development Kit 1.6 (As of February 2012, this was Update 30 on Windows). The link below is for Windows 64-bit. For other operating systems, find a version of Java SDK 1.6. Apparently version 1.7 will not currently work with the current version of Android, so get 1.6.
http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u30-download-1377139.html
(This is a dependency for the Android SDK)
-
Install the Java SE Development Kit 1.6
-
Download Android SDK (the recommended windows installer)
-
Install the Android SDK – This will automatically open the Android SDK and AVD Manager. Accept All and Install. (Note that if the Android SDK does not detect that the JDK was installed, click back and then forward again or restart the installation.)
a. Open Android SDK Manager (or just "android" on Mac OS) if it is not already open.
b. Check "Android 2.2 (API 8)"
c. Install
Note that if you already have a copy of the Android SDK you may need to update it and ensure that you have downloaded the "Android 2.2 (API 8)" packages. On Windows, be sure to run the SDK Manager as Administrator by right-clicking on the Android SDK Tools -> SDK Manaager application icon and choosing "Run as administrator". If you do not see "Android 2.2 (API 8)" as an option, try installing any suggested packages and then restarting SDK Manager.
-
In IntelliJ, import settings.
a. Click File -> Export Settings... and backup your own settings first.
b. Download the CollaboRhythm settings from https://github.com/newmediamedicine/CollaboRhythm/blob/master/IntelliJ.IDEA.Settings/CollaboRhythm_IntelliJIdea12_Settings.jar?raw=true
c. Click File -> Import Settings...
d. Select the settings JAR file you downloaded from CollaboRhythm and click OK.
e. Click OK to import all settings.
f. Click OK to restart IntelliJ.
-
In IntelliJ, set the location of the Flex sdk in the Path Variable page of the Settings dialog box
a. Open Settings or Preferences:
- Windows: Click File -> Settings
- Mac OS: InjtelliJ IDEA -> Preferences...
b. Select “Path Variable”
c. PROJECT_FRAMEWORKS:
- Windows 32-bit: C:\Program Files\Adobe\Flex\sdks\4.6.0\frameworks
- Windows 64-bit: C:\Program Files (x86)\Adobe\Flex\sdks\4.6.0\frameworks
- Mac OS: /Applications/Documents/SDKs 4.6.0/frameworks
d. FLEX_SDK_HOME:
- Windows 32-bit: C:\Program Files\Adobe\Flex\sdks\4.6.0
- Windows 64-bit: C:\Program Files (x86)\Adobe\Flex\sdks\4.6.0
- Mac OS: /Applications/Documents/SDKs 4.6.0
-
Ensure that the SDK settings are correct.
a. Click File -> Project Structure...
b. Select “SDKs” under “Platform Settings”
c. Select “4.6.0”. "Flex SDK home path" should be the Flex SDK directory you created in step 8 above (ending in 4.6.0). If “4.6.0” does not exist, add it by clicking the Add New SDK button (+) and specifying the correct path.
d. Select the Java SDK named "1.6". "JSDK home path" should be the path to the Java SDK you installed in step 11 above. If "1.6" does not exist, add the Java SDK by clicking the Add New SDK button (+) and specifying the correct path. Typical paths:
- Windows 64-bit: C:\Program Files\Java\jdk1.6.0_25
- Mac OS: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/
e. Select the Android SDK named "Android 2.2 Platform". The "Android SDK home path" should be the path to the Android SDK you installed in step 13 above. If "Android 2.2 Platform" does not exist, add the Android SDK by clicking the Add New SDK button (+) and specifying the correct path. Typical paths:
- Windows 64-bit: C:\Program Files (x86)\Android\android-sdk
- Mac OS: /Applications/android-sdk-macosx
g. For "Android 2.2 Platform" verify that the paths under the Classpath tab are correct. Add or update the paths as appropriate based on where you installed the Android SDK.
- Mac OS: platforms/android-8/android.jar and JavaDocs at $android-sdk-macosx/docs/references
-
Optional: get source/documentation for additional libraries and specify path variables. You can skip this step unless you want to be able to debug or see documentation for these libraries. For each library you may download a copy and then update the corresponding path variable to point to the local copy of the library.
a. FLEXUNIT_HOME - FlexUnit is a unit testing framework for Flex: http://flexunit.org/releases/flexunit-4.1.0-8-4.1.0.16076.zip
b. J2AS3_COLLECTIONS_HOME - J2AS3Collections is a set of collection classes including HashMap: https://github.com/newmediamedicine/j2as3
c. NATIVE_APPLICATION_UPDATER_HOME - NativeApplicationUpdater is a library to facilitate application updates on Android (without using the app store): https://github.com/newmediamedicine/NativeApplicationUpdater