Difference between revisions of "Fast and Furious"
(→Checkout a working copy of LogicalDOC CE) |
(→Compiling the web interface) |
||
| (34 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
== Requirements == | == Requirements == | ||
| − | You need Tortoise SVN client (TortoiseSVN 1.8. | + | You need Tortoise SVN client (TortoiseSVN 1.8.10), Java JDK 1.7, Maven 3.2.5, Maven Ant Tasks 2.1.3, Ant 1.7.1, Eclipse Luna 4.4.1, Tomcat 7.0.57 |
== Prepare the Workspace == | == Prepare the Workspace == | ||
Create the folder workspace71 as sub folder of your Home Directory.<br/> | Create the folder workspace71 as sub folder of your Home Directory.<br/> | ||
| − | In my case, since the home directory of my user is: | + | In my case, since the home directory of my user is: C:\Users\george ,I have to create the folder path C:\Users\george\workspace71 |
| − | |||
| − | |||
| − | I have to create the folder path | ||
| − | |||
[[File:01ff-create-workspace.gif]] | [[File:01ff-create-workspace.gif]] | ||
| Line 30: | Line 26: | ||
This are the SVN paths for source and target<br/> | This are the SVN paths for source and target<br/> | ||
svn://svn.code.sf.net/p/logicaldoc/code/build/ant/trunk<br/> | svn://svn.code.sf.net/p/logicaldoc/code/build/ant/trunk<br/> | ||
| − | C:\Users\ | + | C:\Users\george\workspace71\ant |
<gallery> | <gallery> | ||
| Line 39: | Line 35: | ||
svn://svn.code.sf.net/p/logicaldoc/code/build/poms/trunk<br/> | svn://svn.code.sf.net/p/logicaldoc/code/build/poms/trunk<br/> | ||
| − | C:\Users\ | + | C:\Users\george\workspace71\poms |
svn://svn.code.sf.net/p/logicaldoc/code/community/logicaldoc/trunk<br/> | svn://svn.code.sf.net/p/logicaldoc/code/community/logicaldoc/trunk<br/> | ||
| − | C:\Users\ | + | C:\Users\george\workspace71\logicaldoc |
== Install the parent dependencies == | == Install the parent dependencies == | ||
| Line 50: | Line 46: | ||
[[File:04-install-the-parent-dependencies.gif]] | [[File:04-install-the-parent-dependencies.gif]] | ||
| + | |||
| + | Note: this process involves downloading several libraries from the Internet and may take a few tens of minutes to complete (depending on the speed of your internet connection). | ||
| + | |||
| + | == Prepare the project for Eclipse == | ||
| + | We're going to generate a project for Eclipse using the Maven's plugin with the same name.<br/> | ||
| + | By launching this command Maven will download all the dependencies (jar libraries) of the project and will produce a project file for Eclipse with all the libraries already linked (ready for compilation). | ||
| + | cd ..\logicaldoc | ||
| + | mvn eclipse:eclipse | ||
| + | Note: even this command launches the download of several libraries from the internet | ||
| + | |||
| + | == Load the project in Eclipse == | ||
| + | |||
| + | Start Eclipse by specifying the workspace path C:\Users\george\workspace71 | ||
| + | |||
| + | [[File:05ff-eclipse-select-workspace.gif]] | ||
| + | |||
| + | === Import the project logicaldoc === | ||
| + | |||
| + | Import the project logicaldoc and all its children projects. | ||
| + | |||
| + | The images below describe in sequence the steps required to import the project logicaldoc and all its sub-projects that make it up. | ||
| + | |||
| + | <gallery> | ||
| + | File:06a-eclipse-import-project.png|1 | ||
| + | File:06b-eclipse-import-project.png|2 | ||
| + | File:06c-eclipse-import-project.png|3 | ||
| + | File:06d-eclipse-import-project.png|4 | ||
| + | File:06e-eclipse-import-project.png|5 | ||
| + | File:06f-eclipse-import-project.png|6 | ||
| + | </gallery> | ||
| + | |||
| + | # Starting the import procedure | ||
| + | # Selecting the type of project | ||
| + | # Selecting the project root directory | ||
| + | # Selecting the project root directory 02 | ||
| + | # Projects children of the root folder are marked to be imported | ||
| + | # The projects have been imported into the workspace | ||
| + | |||
| + | == Building the sources == | ||
| + | After importing the projects, you can launch the build of sources from Eclipse.<br/> | ||
| + | All this is already ready to use, there is nothing to do, the libraries needed for compilation have already been downloaded previously from Maven and linked to the Eclipse project from the command mvn that we previously launched in step [[#Prepare the project for Eclipse|Prepare the project for Eclipse]] | ||
| + | |||
| + | == Compiling the web interface == | ||
| + | |||
| + | Although it is possible to build the sources that is not enough to render the web interface of LogicalDOC (GUI) from inside Eclipse.<br/> | ||
| + | This is because the LogicalDOC's web interface is based on the [http://en.wikipedia.org/wiki/Google_Web_Toolkit Google GWT framework]. | ||
| + | |||
| + | So we need to perform some operations on the project logicaldoc-gui.<br/> | ||
| + | But before doing this we need to [[install the Google plugins for Eclipse]]. | ||
| + | |||
| + | After installing the Google's plugins we will specify a nature for the project logicaldoc-gui which contains the code to render the Web GUI of LogicalDOC. | ||
| + | |||
| + | The gallery below shows the various steps of the configuration. | ||
| + | |||
| + | <gallery> | ||
| + | File:08a-configure-project-nature.png|1 | ||
| + | File:08b-configure-project-nature.png|2 | ||
| + | File:08c-configure-project-nature.png|3 | ||
| + | File:08d-configure-project-nature.png|4 | ||
| + | File:08e-configure-project-nature.png|5 | ||
| + | File:08f-configure-project-nature.png|6 | ||
| + | File:08g-configure-project-nature.png|7 | ||
| + | </gallery> | ||
| + | |||
| + | # Activate the contextual menu on the project logicaldoc-gui and select Google -> Web Toolkit Settings... | ||
| + | # Select the checkbox Use Google Web Toolkit | ||
| + | # GWT libraries are added to the project | ||
| + | # Launch the compilation by selecting from Google's menu GWT Compile project | ||
| + | # We choose to compile only the frontend module | ||
| + | # Compilation output | ||
| + | # The product of the compilation is stored in the subfolder war/frontend | ||
| + | |||
[[Category: Developer Guide]] | [[Category: Developer Guide]] | ||
Latest revision as of 16:11, 29 June 2015
Contents
Introduction
The developer environment can be set in any Operating System (Windows, Linux, etc..) since LogicalDOC is a multi-platform system, but we recommend Windows, since it is the development environment of reference.
As a result, most of the examples will show paths and screenshots of Windows.
Requirements
You need Tortoise SVN client (TortoiseSVN 1.8.10), Java JDK 1.7, Maven 3.2.5, Maven Ant Tasks 2.1.3, Ant 1.7.1, Eclipse Luna 4.4.1, Tomcat 7.0.57
Prepare the Workspace
Create the folder workspace71 as sub folder of your Home Directory.
In my case, since the home directory of my user is: C:\Users\george ,I have to create the folder path C:\Users\george\workspace71
Checkout a working copy of LogicalDOC CE
Checkout the following packages from the SVN repository of LogicalDOC CE on SourceForge:
ant, poms, logicaldoc
Checkout the LD's ant package using TortoiseSVN
Note: when you install TortoiseSVN on your Windows system it will add two new items to the contextual menu: SVN Checkout... and TortoiseSVN; you can activate the contextual menu simply using the right mouse click on a folder.
This are the SVN paths for source and target
svn://svn.code.sf.net/p/logicaldoc/code/build/ant/trunk
C:\Users\george\workspace71\ant
SVN Checkout contextual menu (mouse right click)
Checkout the LD's ant package
Repeat the steps above for the other two packages below
svn://svn.code.sf.net/p/logicaldoc/code/build/poms/trunk
C:\Users\george\workspace71\poms
svn://svn.code.sf.net/p/logicaldoc/code/community/logicaldoc/trunk
C:\Users\george\workspace71\logicaldoc
Install the parent dependencies
At this point you need to install the dependencies shared by the various LogicalDOC's modules.
To do this, open a command shell, move to the folder poms and run the command:
mvn clean install
Note: this process involves downloading several libraries from the Internet and may take a few tens of minutes to complete (depending on the speed of your internet connection).
Prepare the project for Eclipse
We're going to generate a project for Eclipse using the Maven's plugin with the same name.
By launching this command Maven will download all the dependencies (jar libraries) of the project and will produce a project file for Eclipse with all the libraries already linked (ready for compilation).
cd ..\logicaldoc mvn eclipse:eclipse
Note: even this command launches the download of several libraries from the internet
Load the project in Eclipse
Start Eclipse by specifying the workspace path C:\Users\george\workspace71
Import the project logicaldoc
Import the project logicaldoc and all its children projects.
The images below describe in sequence the steps required to import the project logicaldoc and all its sub-projects that make it up.
1
2
3
4
5
6
- Starting the import procedure
- Selecting the type of project
- Selecting the project root directory
- Selecting the project root directory 02
- Projects children of the root folder are marked to be imported
- The projects have been imported into the workspace
Building the sources
After importing the projects, you can launch the build of sources from Eclipse.
All this is already ready to use, there is nothing to do, the libraries needed for compilation have already been downloaded previously from Maven and linked to the Eclipse project from the command mvn that we previously launched in step Prepare the project for Eclipse
Compiling the web interface
Although it is possible to build the sources that is not enough to render the web interface of LogicalDOC (GUI) from inside Eclipse.
This is because the LogicalDOC's web interface is based on the Google GWT framework.
So we need to perform some operations on the project logicaldoc-gui.
But before doing this we need to install the Google plugins for Eclipse.
After installing the Google's plugins we will specify a nature for the project logicaldoc-gui which contains the code to render the Web GUI of LogicalDOC.
The gallery below shows the various steps of the configuration.
1
2
3
4
5
6
7
- Activate the contextual menu on the project logicaldoc-gui and select Google -> Web Toolkit Settings...
- Select the checkbox Use Google Web Toolkit
- GWT libraries are added to the project
- Launch the compilation by selecting from Google's menu GWT Compile project
- We choose to compile only the frontend module
- Compilation output
- The product of the compilation is stored in the subfolder war/frontend
