Installation

From ZKDesktop

Jump to: navigation, search

Contents

[edit]

Overview

The following instructions will get you up and running with Eclipse for development on the ZK Desktop-based web site. It looks like a lot, but it's really not that bad. If you already have some of the following software installed, you can probably keep it and just confirm all the settings.

As always, if all else fails, "...take off and nuke the entire site from orbit. It's the only way to be sure."

[edit]

Developer or User?

These instructions are intended for developers interested in creating applications for the Zero Kelvin Desktop. If you just want to play with it, download the demo instead.

[edit]

General Notes

Pathnames and certain programs (like the Java JDK) are referred to using their Windows locations. UNIXish users will need to substitute the appropriate locations for their particular operating system and distribution.

The following example uses c:\sandbox\workspace-zkdesktop as the location for installing the source and sample web site. You may choose any location you wish. The instructions assume the default location, so substitute your location for c:\sandbox\workspace-zkdesktop wherever you see it.

[edit]

Mac OS X Notes

Menu options in Eclipse under Mac OS X are not always in the same location as other operating systems. For example, "Window->Preferences" is located under "Eclipse->Preferences" on the Mac. If anything else isn't where it should be, just poke around until you find it. The instructions below use the more common "Window->Preferences" location.

[edit]

Install Java

[edit]

Install Eclipse

[edit]

Create Sandbox

  • Create "C:\sandbox\workspace-zkdesktop".
[edit]

Configure Eclipse

  • Start Eclipse.
  • Use the C:\sandbox\workspace-zkdesktop folder for your workspace.
  • Click the little swoopy arrow icon to go to the workbench.
  • Select "Window->Preferences...".
  • Select the "Install/Update" leaf.
  • Check "Automatically select mirrors".
  • Set "Valid Updates" to "compatible".
  • Expand the "Java" leaf and select "Installed JREs".
  • Click "Search...".
  • Browse to "C:\Program Files\Java" and click "OK".
  • Find the latest version of the JDK (not the JRE) in the "Installed JREs" list and check it.
  • Click "OK" to apply this change.
  • Select "Window->Preferences..." again.
  • Expand the "Java" and then the "Installed JREs" leaf and select "Execution Environments".
  • Click on "JavaSE-1.6".
  • Under "Compatible JREs" click the latest version of the JDK listed as "[perfect match]".
  • Click "OK".
[edit]

Update Eclipse

  • Go to "Help->Software Updates->Find and Install...".
  • Select "Search for updates" and click "Finish".
  • If any updates are found, select them all by checking the topmost box next to each one.
(If there are any errors selecting packages, you may have to resolve them manually.)
  • Click "Next".
  • Select "I accept the terms" and click "Next >".
  • Click "Finish".
  • Click "Install All".
  • If prompted to restart Eclipse, click "Yes".
[edit]

Add Features To Eclipse

  • Go back to "Help->Software Updates->Find and Install...".
  • Select "Search for new features to install" and click "Next".
  • Click "New Remote Site...".
  • Name is "Subclipse Update Site".
  • URL is "http://subclipse.tigris.org/update_1.2.x".
  • Click "OK".
  • The site you just added should be checked. If not, check it.
  • Check "Europa Discovery Site" as well.
  • Click "Finish".
  • Expand the "Europa Discovery Site" tree.
  • Check "Communications".
  • Check "Database Development".
  • Check "Java Development".
  • Expand the "Subclipse Update Site" tree.
  • Expand the "Integrations (Optional)" tree.
  • Check the "Subclipse Integration for Mylyn" option.
  • Check the "Subclipse Plugin" branch.
  • Click the "Select Required" button.
  • Click "Next >".
  • Select "I accept the terms" and click "Next >".
  • If the "Optional Features" dialog is displayed, click "Select All" and then click "Next >".
  • Click "Finish".
  • Click "Install All".
  • If prompted to restart Eclipse, click "Yes".
[edit]

Check Out Support Files

  • From the "Window" menu, select "Open Perspective->Other".
  • Select "SVN Repository Exploring" from the list.
  • Click "OK".
  • Right-click in the "SVN Repository" window and select "New->Repository Location...".
  • Enter "http://zkdesktop.svn.sourceforge.net/svnroot/zkdesktop" for the Url.
  • Click "Finish".
  • In the "SVN Repository" window, expand the tree until you see the "Kickstart" folder.
  • Right-click on "Kickstart" and select "Checkout".
  • When the "Checkout from SVN" window appears, click "Finish".
  • Once it's finished, select the "Window" menu and "Open Perspective->Other".
  • Select "Java EE" from the list and click "OK".
[edit]

Run the Kickstart Utility

  • Right-click on "Kickstart" in the "Package Explorer" window.
  • Select "Run As->Java Application".
[edit]

Import Path Variables

  • Go to "File->Import...".
  • Expand the "General" branch of the tree.
  • Select "Preferences" and click "Next".
  • Click "Browse" and locate "C:\sandbox\workspace-zkdesktop\Kickstart\Imports\pathVariables.epf".
  • Click "Finish".
[edit]

Import Team Project Set

  • Go to "File->Import..." again.
  • Expand the "Team" branch of the tree.
  • Select "Team Project Set" and click "Next".
  • Click "Browse" and locate "C:\sandbox\workspace-zkdesktop\Kickstart\Imports\projectSet.psf".
  • Click "Finish".
  • If prompted to overwrite the Kickstart project, click "No".
  • If prompted, enter your SVN credentials.
  • If prompted for a certificate, accept it permanently.
  • At this point, you will likely get an error about the build. This is OK.
[edit]

Import User Libraries

  • Go to "Window->Preferences...".
  • Expand "Java->Build Path->User Libraries" in the tree.
  • Click "Import...".
  • Click "Browse" and locate "C:\sandbox\workspace-zkdesktop\Kickstart\Imports\userLibraries.userlibraries".
  • Click "OK".
  • Click "OK" again.
[edit]

Run the Kickstart Utility Again

  • Right-click on "Kickstart" in the "Package Explorer" window.
  • Select "Run As->Java Application".
[edit]

Configure Tomcat

  • Go to "Window->Show View->Other...".
  • Expand the "Server" branch of the tree.
  • Select "Servers" and click "OK".
  • In the new "Servers" view window, right-click and select "New->Server".
  • Under the "Apache" branch, select "Tomcat v6.0 Server".
  • Click "Next".
  • Click "Browse" to locate the installation directory.
  • Browse to "C:\sandbox\workspace-zkdesktop\Tomcat" and click "OK".
  • Click "Next".
  • Click "Add All >>" and then "Finish".
[edit]

Refresh Eclipse

  • Click the first project in the "Package Explorer" window on the left.
  • Shift-click the last project in the ""Package Explorer" window.
  • Right-click on one of the highlighted projects and select "Refresh".
[edit]

Get Talking (Optional, but recommended)

  • Go to "Window->Customize Perspective...".
  • Click the "Commands" tab.
  • Check the box next to "Communications" in the "Available command groups" box.
  • Click "OK".
  • Find the icon of the little blue person with a yellow speech balloon above them and click the little down arrow on it.
  • Select "IRC" from the dropdown list.
  • For a "Connect ID", enter "<name>@irc.freenode.net/ZKDesktop" where "<name>" is your first name in proper case.
  • Click "Finish".
[edit]

Optional (Yet Cool) Stuff

[edit]

Care and Feeding of Your New IDE

When you relaunch the IDE, you are not automatically connected to the IRC channel for the ZK Desktop. Please do this by clicking on the down arrow on the little blue person icon and selecting "IRC". The more people that use the IRC channel, the more assistance we will all be to each other!

Every so often, you need to update your Eclipse installation. Once a week or so, repeat the steps listed under "Update Eclipse" above.

Retrieved from "http://zkdesktop.sourceforge.net/wiki/index.php/Installation"
Personal tools