Cloning and Using a Fork of CollaboRhythm

1. Open IntelliJ

2. Click on Version Control -> Checkout from Version Control -> GitHub

3. Enter or create a master password if prompted

4. Enter your GitHub credentials and click Login

5. You will prompted to “Select repository to clone”. Select the forked repository that you created (or was created for your team), such as CollaboRhythmMayo. See Forking CollaboRhythm if you do not have a fork yet or contact one of your team members for details on the fork. If someone else on your team created the fork, they may need to add you as a collaborator.

6. Choose and specify an appropriate location for the Parent Directory to store your git repositories, such as C:\Users\user1\Documents\GitHub\ (create the directory if it does not exist).

7. Specify the Directory Name. You should probably choose the same name as the forked repository, such as CollaboRhythmMayo

8. You will be prompted for the SSH Key Passphrase. Specify your local SSH passphrase that you defined when you set up Git.

9. The repository will be downloaded. You will then be prompted “You have checked out an IntelliJ IDEA project: <your path> Would you like to open it?”. Click Yes to open the existing project.

10. If you have another project open you will be prompted to open the project in a new or existing window. Make an appropriate choice to continue and the project will open.

11. If you want to build CollaboRhythm.Android.DeviceGateway you will need to copy the file BluetoothSocketThread.java to the following location: <CollaboRhythmRepositoryLocation>\CollaboRhythm.Android.DeviceGateway\src\collaboRhythm\android\deviceGateway\BluetoothSocketThread.java. If you do not have this file and do not need to build this module, you can skip this step and ignore the corresponding build error (step 13 below). If you do not build CollaboRhythm.Android.DeviceGateway you can still install it by downloading the latest build and installing the APK file.

12. If you are running Mac OS, you may need to resolve an issue with fonts (as of Feb 3, 2012 this is still not resolved):

    a. In $CollaboRhythm$/CollaboRhythm.Core/src/collaboRhythm/core/AssetManager.as change the path to Verdana font to some in your computer (e.g. /Library/Fonts/Microsoft/verdana.ttf)

13. Change the compiler setting to not use external build.

    a. File -> Settings (or Preferences on Mac OS X)

    b. Select Compiler

    c. Un-check "Use external build".

    d. Click OK. This will force IntelliJ to use the internal ActionScript compiler, which should build up to four modules at a time and dramatically improve build times.

14. Click Build -> Make Project.

15. If everything is configured correctly, all of the modules in the project should build successfully, with some warnings but no errors. Confirm that all modules are built and resolve any errors if necessary.

16. Select the run configuration for CollaboRhythm.Workstation

17. Debug CollaboRhythm.Workstation

18. The application should open with no errors. You should see a list of patients that the default account (James King) has access to.

19. Click on patient Carlos Santos. His record should open and you should see various widgets, including a clock.

20. Click on the clock. You should see the medication scheduling app open below the widgets.

21. Press the Esc key to exit CollaboRhythm.Workstation.

22. You can also test “CollaboRhythm.Tablet Emulator” and “CollaboRhythm.Mobile Emulator”, and if you have a properly configured Android device connected, you can try “CollaboRhythm.Tablet Device” and “CollaboRhythm.Mobile Device”.