| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one | |
| or more contributor license agreements. See the NOTICE file | |
| distributed with this work for additional information | |
| regarding copyright ownership. The ASF licenses this file | |
| to you under the Apache License, Version 2.0 (the | |
| "License"); you may not use this file except in compliance | |
| with the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, | |
| software distributed under the License is distributed on an | |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| KIND, either express or implied. See the License for the | |
| specific language governing permissions and limitations | |
| under the License. | |
| --> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <!-- Generated by Apache Maven Doxia at Jun 7, 2012 --> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <title> | |
| Setup your Development Environment</title> | |
| <style type="text/css" media="all"> | |
| @import url("./css/james.css"); | |
| @import url("./css/maven-base.css"); | |
| @import url("./css/maven-theme.css"); | |
| @import url("./css/site.css"); | |
| @import url("./js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css"); | |
| @import url("./js/jquery/css/print.css"); | |
| @import url("./js/fancybox/jquery.fancybox-1.3.4.css"); | |
| </style> | |
| <script type="text/javascript" src="./js/jquery/js/jquery-1.4.2.min.js"></script> | |
| <script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> | |
| <script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script> | |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> | |
| <meta name="author" content="James Hupa Project Team" /> | |
| <meta name="Date-Revision-yyyymmdd" content="20120607" /> | |
| <meta http-equiv="Content-Language" content="en" /> | |
| <link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/> | |
| <!-- Google Analytics --> | |
| <script type="text/javascript"> | |
| var _gaq = _gaq || []; | |
| _gaq.push(['_setAccount', 'UA-1384591-1']); | |
| _gaq.push(['_trackPageview']); | |
| (function() { | |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; | |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; | |
| var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s); | |
| })(); | |
| </script> | |
| </head> | |
| <body class="composite"> | |
| <div id="banner"> | |
| <a href="index.html" id="bannerLeft" title="james-hupa-logo.gif"> | |
| <img src="images/logos/james-hupa-logo.gif" alt="James Hupa" /> | |
| </a> | |
| <a href="http://www.apache.org/index.html" id="bannerRight"> | |
| <img src="images/logos/asf-logo-reduced.gif" alt="The Apache Software Foundation" /> | |
| </a> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| <div id="breadcrumbs"> | |
| <div class="xleft"> | |
| <span id="publishDate">Last Published: 2012-06-07</span> | |
| </div> | |
| <div class="xright"> <a href="../index.html" title="Home">Home</a> | |
| | | |
| <a href="../server/index.html" title="Server">Server</a> | |
| | | |
| <a href="index.html" title="Hupa">Hupa</a> | |
| | | |
| <a href="../protocols/index.html" title="Protocols">Protocols</a> | |
| | | |
| <a href="../imap/index.html" title="IMAP">IMAP</a> | |
| | | |
| <a href="../mailet/index.html" title="Mailets">Mailets</a> | |
| | | |
| <a href="../mailbox/index.html" title="Mailbox">Mailbox</a> | |
| | | |
| <a href="../mime4j/index.html" title="Mime4J">Mime4J</a> | |
| | | |
| <a href="../jsieve/index.html" title="jSieve">jSieve</a> | |
| | | |
| <a href="../jspf/index.html" title="jSPF">jSPF</a> | |
| | | |
| <a href="../jdkim/index.html" title="jDKIM">jDKIM</a> | |
| | | |
| <a href="../mpt/index.html" title="MPT">MPT</a> | |
| | | |
| <a href="../postage/index.html" title="Postage">Postage</a> | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| <div id="leftColumn"> | |
| <div id="navcolumn"> | |
| <h5>Hupa</h5> | |
| <ul> | |
| <li class="none"> | |
| <a href="index.html" title="Overview">Overview</a> | |
| </li> | |
| <li class="none"> | |
| <a href="screenshots.html" title="Screenshots">Screenshots</a> | |
| </li> | |
| <li class="none"> | |
| <a href="configuration.html" title="Configuration">Configuration</a> | |
| </li> | |
| <li class="none"> | |
| <a href="faq.html" title="FAQs">FAQs</a> | |
| </li> | |
| </ul> | |
| <h5>Get Involved</h5> | |
| <ul> | |
| <li class="none"> | |
| <strong>Setup</strong> | |
| </li> | |
| <li class="none"> | |
| <a href="building.html" title="Building">Building</a> | |
| </li> | |
| </ul> | |
| <h5>Project</h5> | |
| <ul> | |
| <li class="none"> | |
| <a href="https://issues.apache.org/jira/browse/HUPA" title="Issue Tracker">Issue Tracker</a> | |
| </li> | |
| <li class="none"> | |
| <a href="source-repository.html" title="Source Code">Source Code</a> | |
| </li> | |
| <li class="none"> | |
| <a href="javadoc.html" title="Javadoc">Javadoc</a> | |
| </li> | |
| <li class="none"> | |
| <a href="team-list.html" title="Who We Are">Who We Are</a> | |
| </li> | |
| <li class="none"> | |
| <a href="license.html" title="License">License</a> | |
| </li> | |
| </ul> | |
| <h5>About James</h5> | |
| <ul> | |
| <li class="none"> | |
| <a href="../index.html" title="Overview">Overview</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../newsarchive.html" title="News">News</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../mail.html" title="Mailing Lists">Mailing Lists</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../contribute.html" title="Contributing">Contributing</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../guidelines.html" title="Guidelines">Guidelines</a> | |
| </li> | |
| <li class="none"> | |
| <a href="http://wiki.apache.org/james" title="Wiki">Wiki</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../team-list.html" title="Who We Are">Who We Are</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../license.html" title="License">License</a> | |
| </li> | |
| </ul> | |
| <h5>Download</h5> | |
| <ul> | |
| <li class="none"> | |
| <a href="../download.cgi" title="Releases">Releases</a> | |
| </li> | |
| <li class="none"> | |
| <a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/" title=""></a> | |
| </li> | |
| </ul> | |
| <h5>Apache Software Foundation</h5> | |
| <ul> | |
| <li> | |
| <strong> | |
| <a title="ASF" href="http://www.apache.org/">ASF</a> | |
| </strong> | |
| </li> | |
| <li> | |
| <a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a> | |
| </li> | |
| <li> | |
| <a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a> | |
| </li> | |
| <li> | |
| <a title="License" href="http://www.apache.org/licenses/" >License</a> | |
| </li> | |
| <li> | |
| <a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> | |
| </li> | |
| <li> | |
| <a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a> | |
| </li> | |
| <li> | |
| <a title="Security" href="http://www.apache.org/security/">Security</a> | |
| </li> | |
| </ul> | |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> | |
| <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> | |
| </a> | |
| </div> | |
| </div> | |
| <div id="bodyColumn"> | |
| <div id="contentBox"> | |
| <!-- Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed with this | |
| work for additional information regarding copyright ownership. The ASF | |
| licenses this file to you under the Apache License, Version 2.0 (the | |
| "License"); you may not use this file except in compliance with the License. | |
| You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law | |
| or agreed to in writing, software distributed under the License is | |
| distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| KIND, either express or implied. See the License for the specific language | |
| governing permissions and limitations under the License. --> | |
| <div class="section"><h2>So you want to get involved?<a name="So_you_want_to_get_involved"></a></h2> | |
| <p> | |
| Great! Hupa is a new project, which just made it from the labs over to | |
| the james | |
| project. | |
| We have a solid codebase, but there are many features | |
| missing. But you already | |
| know that, right? | |
| At least that is why you are | |
| trying to help, correct? | |
| </p> | |
| <p> | |
| So, what do you need... We develop in eclipse, hence this document | |
| describes | |
| how to setup eclipse, | |
| to get a Hupa Development Environment up | |
| and running. So if you are a | |
| developer who is using netbeans | |
| or any other | |
| IDE like IntelliJ IDEA, don't hesitate, to tell us how you setup | |
| your | |
| Environment, and | |
| we will be more than happy to include the documentation | |
| as well. | |
| </p> | |
| <p> | |
| This document describes which steps are needed to setup eclipse, as if | |
| it was | |
| freshly downloaded. | |
| So if you already have some plugins installed, | |
| skip over to the next section. | |
| Other than that, | |
| all that is left for is to | |
| wish you guys fun coding Hupa! | |
| </p> | |
| </div> | |
| <div class="section"><h2>How to setup eclipse...<a name="How_to_setup_eclipse..."></a></h2> | |
| <div class="section"><h3>What Version do you need<a name="What_Version_do_you_need"></a></h3> | |
| <p> | |
| Eclipse can be downloaded from | |
| <a class="externalLink" href="http://download.eclipse.org">the eclipse download page</a> | |
| I recommend using the Eclipse IDE for Java Developers or the Eclipse | |
| IDE for Java EE Developers. | |
| </p> | |
| <p> | |
| If you need help installing eclipse, you can find the answers you are | |
| looking for on the | |
| <a class="externalLink" href="http://wiki.eclipse.org/FAQ_Where_do_I_get_and_install_Eclipse%3F">eclipse homepage</a> | |
| </p> | |
| <p> | |
| From this point on we assume you have a running distribution of | |
| eclipse installed on your system. | |
| </p> | |
| </div> | |
| <div class="section"><h3>Setting up the maven eclipse plugin<a name="Setting_up_the_maven_eclipse_plugin"></a></h3> | |
| <p> | |
| Hupa uses maven2 as its build tool. Although it is possible to only | |
| run maven commands | |
| from the command line, a tight integration into the | |
| tool you use to write and run the code is a lot nicer. | |
| </p> | |
| <p> | |
| Nowadays there is more than one plugin for eclipse to interact with | |
| maven2. Although all might be great, I only know my way around the | |
| m2eclipse plugin. I work | |
| with it on all my m2 projects, and it provides | |
| me with the tools I need to get | |
| the job done. Again, if you provide the | |
| documentation for other | |
| plugins, we would be more than happy to put | |
| them up here. | |
| </p> | |
| <p> | |
| But enough of the bla bla let us get started. You can download the | |
| plugin | |
| <a class="externalLink" href="http://m2eclipse.sonatype.org/">here.</a> | |
| The Installation Instructions are right on the first page. From this | |
| point this guide assumes that you have the m2eclipse plugin installed. | |
| </p> | |
| </div> | |
| <div class="section"><h3>Setting up the GWT Plugin<a name="Setting_up_the_GWT_Plugin"></a></h3> | |
| <p> | |
| Hupa is developed using | |
| <a class="externalLink" href="http://code.google.com/intl/de/webtoolkit/">GWT</a> | |
| So to make your development a lot easier we recommend installing the | |
| <a class="externalLink" href="http://code.google.com/appengine/docs/java/tools/eclipse.html">google plugin for eclipse</a> | |
| </p> | |
| </div> | |
| <div class="section"><h3>Setting up subclipse<a name="Setting_up_subclipse"></a></h3> | |
| <p> | |
| The ASF uses subversion as its Version Control System (VCS). So to be | |
| able to check out the source code I recommend using a special plugin | |
| called | |
| <a class="externalLink" href="http://subclipse.tigris.org/">subclipse</a> | |
| After subclipse is installed, it is fairly easy to start your | |
| development on Hupa :) | |
| </p> | |
| </div> | |
| <div class="section"><h3>Checking out the Hupa source code<a name="Checking_out_the_Hupa_source_code"></a></h3> | |
| <p> | |
| Now we have everything setup to be able to check out and run the Hupa | |
| source code. | |
| </p> | |
| <p> | |
| Open up Eclipse and go to Window -> Open Perspective -> Other -> SVN | |
| Repository Exploring | |
| <br /> | |
| <img src="images/dev/svn-repo.jpg" alt="" /> | |
| <br /> | |
| In the SVN Repositories View Click the right mouse button and choose | |
| New -> Repository Location ... | |
| </p> | |
| <p> | |
| In the Dialog enter the following url in the URL Field: | |
| http://svn.apache.org/repos/asf then click on Finish. After that the | |
| ASF Software Repository should be visible inside your SVN Repositories | |
| view as shown here. | |
| <br /> | |
| <img src="images/dev/svn-repositories-installed.jpg" alt="" /> | |
| <br /> | |
| </p> | |
| <p> | |
| Expand the Repository, then james, then hupa, and finally do a right | |
| click on trunk and select Checkout. Fill in the settings as you think | |
| they fit your needs. | |
| <br /> | |
| <img src="images/dev/checkout-hupa.jpg" alt="" /> | |
| <br /> | |
| </p> | |
| <p> | |
| So after everything is set up correctly your screen should look like | |
| this one here. | |
| <br /> | |
| <img src="images/dev/eclipse_setup.jpg" alt="" /> | |
| <br /> | |
| </p> | |
| <p> | |
| Now, that the foundation is laid out, we can finally | |
| <a href="building.html">build hupa</a> | |
| . | |
| </p> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| <div id="footer"> | |
| <div class="xright">Copyright © 2009-2012 | |
| <a href="http://www.apache.org/">The Apache Software Foundation</a>. | |
| All Rights Reserved. | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| </body> | |
| </html> |