From c87424ae809faa38d5bc169cd7c7f7cabb6de432 Mon Sep 17 00:00:00 2001 From: Paulo Gustavo Veiga Date: Wed, 8 Jan 2014 23:28:21 +0000 Subject: [PATCH] Add compilation details temporally. --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8ba8f48b..1c1da813 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,52 @@ The goal of this project is to provide a high quality product that can be deployed by educational and academic institutions, private and public companies and anyone who needs to have a mindmapping application. WiseMapping is based on the same code source supporting WiseMapping.com. More info: www.wisemapping.org +# Compiling and Running -## Author +## Prerequisites + +The following products must be installed: + + * Java Development Kit 7 or higher ([http://www.oracle.com/technetwork/java/javase/downloads/index.html]) + * Maven 3.x or higher ([http://maven.apache.org/]) + +## Compiling + +WiseMapping uses Maven as packaging and project management. It's composed of 5 maven sub-modules: + + * core-js: Utilities JavaScript classes + * web2d: JavaScript 2D SVG abstraction library used by the mind map editor + * mindplot: JavaScript mindmap designer core + * wise-editor: Mindmap Editor standalone distribution + * wise-webapp: J2EE web application + +The full compilation of the project can be performed executing within : + +`mvn package` + +Once this command is execute, the file /wise-webapp/target/wisemapping*.war will be generated. + +## Testing +The previously generated war can be deployed locally executing within the directory /wise-webapp the following command: + +`cd wise-webapp;mvn jetty:run-war` + +This will start the application on the URL: [http://localhost:8080/wise-webapp/]. Additionally, a file based database is automatically populated with a test user. + +User: test@wisemapping.org +Password: test + +## Authors * Pablo Luna * Paulo Veiga +## Past Collaborators + + * Ignacio Manzano + * Nicolas Damonte + ## License The source code is Licensed under the WiseMapping Open License, Version 1.0 (the “License”); -You may obtain a copy of the License at: http://www.wisemapping.org/license +You may obtain a copy of the License at: [https://wisemapping.atlassian.net/wiki/pages/viewpage.action?pageId=524357]