9f120545f6a057621a875040706e1d557b063dd3
wiki/onboarding.md
| ... | ... | @@ -26,50 +26,43 @@ This document describes the onboarding process for a new team member (developer) |
| 26 | 26 | #### Accounts |
| 27 | 27 | |
| 28 | 28 | 1. Git Account |
| 29 | -- Register yourself as a Git user in the SAP-Git under: https://git.wdf.sap.corp:8080/ |
|
| 30 | -- Ask the Git administrator (Axel Uhl) to get on the list of enabled committers |
|
| 31 | - |
|
| 29 | + * Register yourself as a Git user in the SAP-Git under: https://git.wdf.sap.corp:8080/ |
|
| 30 | + * Ask the Git administrator (Axel Uhl) to get on the list of enabled committers |
|
| 32 | 31 | 2. Bugzilla |
| 33 | -- Ask the Bugzilla administrator (Frank Mittag, Axel Uhl) to create a bugzilla account for you. |
|
| 34 | -- Bugzilla url: http://sapsailing.com/bugzilla/ |
|
| 35 | - |
|
| 32 | + * Ask the Bugzilla administrator (Frank Mittag, Axel Uhl) to create a bugzilla account for you. |
|
| 33 | + * Bugzilla url: http://sapsailing.com/bugzilla/ |
|
| 36 | 34 | 3. Race Analysis user |
| 37 | -- Add yourself as an user to the Race Analysis suite by adding a Jetty user in the file |
|
| 38 | - java\target\configuration\jetty\etc\realm.properties |
|
| 35 | + * Add yourself as an user to the Race Analysis suite by adding a Jetty user in the file java\target\configuration\jetty\etc\realm.properties |
|
| 39 | 36 | |
| 40 | 37 | #### Steps to build and run the Race Analysis Suite |
| 41 | 38 | |
| 42 | 39 | 1. Get the content of the git repository |
| 43 | -- Generate SSH Keys with "ssh-keygen -t rsa -C "" " command in Cygwin Terminal (Not with Putty!!!) |
|
| 44 | -- Clone the repository to your local file system from `ssh://[SAP-User]@git.wdf.sap.corp:29418/SAPSail/sapsailingcapture.git` or `ssh://[user]@sapsailing.com/home/trac/git` |
|
| 45 | - |
|
| 40 | + * Generate SSH Keys with "ssh-keygen -t rsa -C "" " command in Cygwin Terminal (Not with Putty!!!) |
|
| 41 | + * Clone the repository to your local file system from `ssh://[SAP-User]@git.wdf.sap.corp:29418/SAPSail/sapsailingcapture.git` or `ssh://[user]@sapsailing.com/home/trac/git` |
|
| 46 | 42 | 2. Check out the 'master' branch from the git repository. The 'master' branch is the main development branch. Please check that you start your work on this branch. |
| 47 | - |
|
| 48 | 43 | 3. Setup and configure Eclipse |
| 49 | - - Make absolutely sure to import CodeFormatter.xml (from $GIT_HOME/java) into your Eclipse preferences (Preferences->Java->Code Style->Fortmatter) |
|
| 50 | - - Install the Eclipse GWT-Plugin (now called Google Plugin for Eclipse, you need the Google WebToolkit SDK from the same update site, too) |
|
| 51 | - - Install the Google Android SDK from the same Google Plugin for Eclipse update site |
|
| 52 | - - Install Eclipse eGit (optional) |
|
| 53 | - - Check that JDK 1.7 is available and has been set for compilation in Eclipse |
|
| 54 | - - Check that the both JDKs are available (Windows->Preferences->Java->Installed JREs) |
|
| 55 | - - Check that JDK 1.6 has been matched to JavaSE-1.6 and that JDK 1.7 has been matched to JavaSE-1.7 (...>Installed JREs>Execution Environments) |
|
| 56 | - - It is also possible to match the SAPJVM 6 or 7 to the JavaSE-1.6 (for profiling purposes) |
|
| 57 | - - Go to Windows->Preferences->Google->Errors/Warnings and set "Missing SDK" to "Ignore" |
|
| 58 | - - Import all Race Analysis projects from the `java/` subdirectory of the git main folder |
|
| 59 | - - Import all projects from the `mobile/` subdirectory of the git main folder; this in particular contains the race committee app projects |
|
| 60 | - - Set the Eclipse target platform to race-analysis-p2-ide-local.target (located in com.sap.sailing.targetplatform/definitions) |
|
| 61 | - - Wait until the target platform has been resolved completely |
|
| 62 | - - In the project com.sap.sailing.gwt.ui create a new subfolder "classes" in the folder WEB-INF |
|
| 63 | - - Rebuild all projects |
|
| 64 | - |
|
| 44 | + * Make absolutely sure to import CodeFormatter.xml (from $GIT_HOME/java) into your Eclipse preferences (Preferences->Java->Code Style->Fortmatter) |
|
| 45 | + * Install the Eclipse GWT-Plugin (now called Google Plugin for Eclipse, you need the Google WebToolkit SDK from the same update site, too) |
|
| 46 | + * Install the Google Android SDK from the same Google Plugin for Eclipse update site |
|
| 47 | + * Install Eclipse eGit (optional) |
|
| 48 | + * Check that JDK 1.7 is available and has been set for compilation in Eclipse |
|
| 49 | + * Check that the both JDKs are available (Windows->Preferences->Java->Installed JREs) |
|
| 50 | + * Check that JDK 1.6 has been matched to JavaSE-1.6 and that JDK 1.7 has been matched to JavaSE-1.7 (...>Installed JREs>Execution Environments) |
|
| 51 | + * It is also possible to match the SAPJVM 6 or 7 to the JavaSE-1.6 (for profiling purposes) |
|
| 52 | + * Go to Windows->Preferences->Google->Errors/Warnings and set "Missing SDK" to "Ignore" |
|
| 53 | + * Import all Race Analysis projects from the `java/` subdirectory of the git main folder |
|
| 54 | + * Import all projects from the `mobile/` subdirectory of the git main folder; this in particular contains the race committee app projects |
|
| 55 | + * Set the Eclipse target platform to race-analysis-p2-ide-local.target (located in com.sap.sailing.targetplatform/definitions) |
|
| 56 | + * Wait until the target platform has been resolved completely |
|
| 57 | + * In the project com.sap.sailing.gwt.ui create a new subfolder "classes" in the folder WEB-INF |
|
| 58 | + * Rebuild all projects |
|
| 65 | 59 | 4. Run the Race Analysis Suite |
| 66 | - - Start the MongoDB |
|
| 67 | - - Start the appropriate Eclipse launch configuration (e.g. 'Sailing Server (Proxy)') You´ll find this in the run dropdown |
|
| 68 | - - Run "SailingGWT" in the run dropdown |
|
| 69 | - |
|
| 60 | + * Start the MongoDB |
|
| 61 | + * Start the appropriate Eclipse launch configuration (e.g. 'Sailing Server (Proxy)') You´ll find this in the run dropdown |
|
| 62 | + * Run "SailingGWT" in the run dropdown |
|
| 70 | 63 | 5. Within the Race Analysis Suite |
| 71 | - - For TracTrac Events: (Date 27.11.2012) Use Live URI tcp://10.18.22.156:4412, Stored URI tcp://10.18.22.156:4413, JSON URL http://germanmaster.traclive.dk/events/event_20120905_erEuropean/jsonservice.php |
|
| 72 | - - Press List Races |
|
| 64 | + * For TracTrac Events: (Date 27.11.2012) Use Live URI tcp://10.18.22.156:4412, Stored URI tcp://10.18.22.156:4413, JSON URL http://germanmaster.traclive.dk/events/event_20120905_erEuropean/jsonservice.php |
|
| 65 | + * Press List Races |
|
| 73 | 66 | |
| 74 | 67 | #### Maven Setup |
| 75 | 68 | Copy the settings.xml from the top-level git folder to your ~/.m2 directory and adjust the proxy settings accordingly. Make sure the mvn executable you installed above is in your path. Open a shell (preferrably a git bash or a cygwin bash), cd to the git workspace's root folder and issue "./configuration/buildAndUpdateProduct.sh build". This should build the software and run all the tests. If you want to avoid the tests being executed, use the -t option. If you only want to build one GWT permutation (Chrome/English), use the -b option. When inside the SAP VPN, add the -p option for proxy use. Run the build script without arguments to get usage hints. |
| ... | ... | @@ -88,20 +81,20 @@ To ensure that all components of the Analysis Suite are working, you should also |
| 88 | 81 | - After restarting Eclipse the "Welcome to Android Development" window should help you with installing the Android SDK |
| 89 | 82 | - It is also possible to download the Android SDK separately from http://developer.android.com/sdk/index.html ("Use an existing IDE") |
| 90 | 83 | 2. Setup the Android SDK |
| 91 | - - In Eclipse press Window -> Android SDK Manager |
|
| 92 | - - Ensure that everything of "Tools" is installed |
|
| 93 | - - Install everything of "Android 3.2 API 13" |
|
| 94 | - - Optional: it's a good idea to install the newest API Version |
|
| 95 | - - Install "Android Support Library" (Extras), "Google Play Services" (Extras) and "Google USB Driver" (Extras) |
|
| 84 | + * In Eclipse press Window -> Android SDK Manager |
|
| 85 | + * Ensure that everything of "Tools" is installed |
|
| 86 | + * Install everything of "Android 3.2 API 13" |
|
| 87 | + * Optional: it's a good idea to install the newest API Version |
|
| 88 | + * Install "Android Support Library" (Extras), "Google Play Services" (Extras) and "Google USB Driver" (Extras) |
|
| 96 | 89 | 3. Import the Android projects into your workspace |
| 97 | - - Android projects can be found in the /mobile subdirectory |
|
| 90 | + * Android projects can be found in the /mobile subdirectory |
|
| 98 | 91 | |
| 99 | 92 | To deploy an Android project (for example com.sap.sailing.racecommittee.app) to a real device: |
| 100 | 93 | |
| 101 | 94 | 1. Plug-in the device |
| 102 | - - Development mode must be enabled on the device |
|
| 103 | - - For certain device/OS combinations additional device drivers are needed |
|
| 104 | - - You can check if the device is detected correctly by checking the "Devices" tab of the "DDMS" Eclipse perspective. |
|
| 95 | + * Development mode must be enabled on the device |
|
| 96 | + * For certain device/OS combinations additional device drivers are needed |
|
| 97 | + * You can check if the device is detected correctly by checking the "Devices" tab of the "DDMS" Eclipse perspective. |
|
| 105 | 98 | 2. Start a run configuration of the project |
| 106 | 99 | 3. Select your attached device in the device selection screen |
| 107 | 100 | 4. The app should be started after deployment |