Index: src/site/site.xml =================================================================== --- src/site/site.xml (revision 823751) +++ src/site/site.xml (working copy) @@ -40,6 +40,9 @@ + + + Index: src/site/resources/images/dev/checkout-hupa.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/checkout-hupa.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/resources/images/dev/eclipse_setup.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/eclipse_setup.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/resources/images/dev/run-configurations-main.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/run-configurations-main.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/resources/images/dev/run-configurations-refresh.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/run-configurations-refresh.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/resources/images/dev/svn-repo.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/svn-repo.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/resources/images/dev/svn-repositories-installed.jpg =================================================================== Cannot display: file marked as a binary type. svn:mime-type = application/octet-stream Property changes on: src/site/resources/images/dev/svn-repositories-installed.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Index: src/site/xdoc/index.xml =================================================================== --- src/site/xdoc/index.xml (revision 823751) +++ src/site/xdoc/index.xml (working copy) @@ -1,22 +1,18 @@ - + 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. + --> Overview @@ -25,26 +21,26 @@

- Hupa is IMAP-based Webmail written in GWT. + Hupa is IMAP-based Webmail written in GWT.

- - - -

Sept/2009 - Hupa moved to James

-

- Hupa moved from Apache Labs to James this month. + + + +

Sept/2009 - Hupa moved to James

+

+ Hupa moved from Apache Labs to James this month.

-
- + +
- +

Latest: None -
- No releases done yet. +
+ No releases done yet. Would like helping getting one together? Check this out

Index: src/site/xdoc/dev/building.xml =================================================================== --- src/site/xdoc/dev/building.xml (revision 0) +++ src/site/xdoc/dev/building.xml (revision 0) @@ -0,0 +1,101 @@ + + + + + Building Hupa + James Hupa Project Team + + +
+

+ Because Hupa uses maven2 as its build tool, the management of + dependencies is rather simple. You can either run + mvn clean package + from the command line, or use the built-in m2eclipse plugin. +

+ +

+ m2eclipse provides you with the ability to create different run + configurations for maven. So you can run + what + you want, + when + you want, by a single mouse-click. To configure the m2 run + configuration, please do a right click on the project name and select + Run As -> Run Configurations ... +

+

+ In the Following Dialog left-click Maven Build, then click on New on + the top. On the dialogs main content area provide the run + configuration now. In the Name field type + hupa clean package + . Uder the Base Directory should be written + ${workspace_loc:/hupa-trunk} + (if your project is only named hupa, then it would be + ${workspace_loc:/hupa}). + + Underneath you should check Update Snaphots + and on the Refresh Tab you + should check Refresh Resources upon + Completion and The Project + Containing the selected Resource. + + After all is set, click Apply and then click Run. It will take a hile + to download all the dependencies. Once it is finished, it will refresh + eclipse, and we are on the final step to start it up the first time. +

+
+
+
+

+ Because Hupa uses the google web toolkit (GWT) it is necessary to + adjust + the output directory of the project. If you don't the Stand alone + google + browser will not be able to pick up the compiled classes. So, to + change + it do a right-click on your project choos Run As -> Web Application. But + beware you will get an error! We do this only because the plugin sets + almost everything up for us. After we get the error right-click on the + project again, and choose Run As -> Run Configurations... then expand + the Web Application Node, go to the Arguments tab and add + -Dhupa.config.file=${project_loc}/server/src/main/webapp/WEB-INF/conf/config.properties + + to the VM Arguments Textbox. Click on Apply and close the dialog. + After + that go into the Package Explorer + View and expand server -> src -> main + -> webapp -> WEB-INF -> conf and + double click on config.properties. + Adjust these settings to your liking. + googlemail is setup by default. + Last thing to setup is the projects output path. Do a right-click on the + project and choose Build Path -> Configure Build Path... Under the + Source tab put <your_project_name>/war/WEB-INF/classes in the + output directory textbox. +

+
+
+

+ So we are finally there. We can run Hupa for the first time. Do a + right-click + on the project choose Run As -> Run Configurations... -> + Hupa.html and + click on run. +

+
+ +
\ No newline at end of file Index: src/site/xdoc/dev/environment.xml =================================================================== --- src/site/xdoc/dev/environment.xml (revision 0) +++ src/site/xdoc/dev/environment.xml (revision 0) @@ -0,0 +1,159 @@ + + + + + Setup your Development Environment + James Hupa Project Team + + +
+

+ 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? +

+

+ 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. +

+

+ 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! +

+
+ +
+ +

+ Eclipse can be downloaded from + the eclipse download page + I recommend using the Eclipse IDE for Java Developers or the Eclipse + IDE for Java EE Developers. +

+

+ If you need help installing eclipse, you can find the answers you are + looking for on the + eclipse homepage +

+

+ From this point on we assume you have a running distribution of + eclipse installed on your system. +

+
+ +

+ 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. +

+

+ 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. +

+

+ But enough of the bla bla let us get started. You can download the + plugin + here. + The Installation Instructions are right on the first page. From this + point this guide assumes that you have the m2eclipse plugin installed. +

+
+ +

+ Hupa is developed using + GWT + So to make your development a lot easier we recommend installing the + google plugin for eclipse +

+
+ +

+ 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 + subclipse + After subclipse is installed, it is fairly easy to start your + development on Hupa :) +

+
+ +

+ Now we have everything setup to be able to check out and run the Hupa + source code. +

+

+ Open up Eclipse and go to Window -> Open Perspective -> Other -> SVN + Repository Exploring + + In the SVN Repositories View Click the right mouse button and choose + New -> Repository Location ... +

+

+ 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 + +

+

+ 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. + +

+

+ So after everything is set up correctly your screen should look like + the one + here. +

+

+ Now, that the foundation is laid out, we can finally + build hupa + . +

+
+
+ +
\ No newline at end of file