wisemapping-open-source/README.md

72 lines
2.3 KiB
Markdown
Raw Normal View History

2014-01-25 19:43:46 +01:00
# Project Information
2011-01-24 16:23:01 +01:00
2011-02-18 03:13:19 +01:00
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
2011-01-24 16:23:01 +01:00
2014-01-25 19:43:46 +01:00
## Compiling and Running
2012-03-19 11:43:40 +01:00
2014-01-25 19:43:46 +01:00
### Prerequisites
2014-01-09 00:28:21 +01:00
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/])
2014-01-25 19:43:46 +01:00
### Compiling
2014-01-09 00:28:21 +01:00
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 <project-dir>:
`mvn package`
Once this command is execute, the file <project-dir>/wise-webapp/target/wisemapping*.war will be generated.
2014-01-25 19:43:46 +01:00
### Testing
2014-01-09 00:28:21 +01:00
The previously generated war can be deployed locally executing within the directory <project-dir>/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
2014-01-25 19:43:46 +01:00
## Running the JS only version
Start by creating the .zip file:
`mvn assembly:assembly -Dmaven.test.skip=true`
To test the javascript frontend you then do:
ruby -rwebrick -e 'WEBrick::HTTPServer.new(:Port=>8000,:DocumentRoot=>".").start'
Now open a browser using the URL http://localhost:8000/wise-editor/src/main/webapp/
2014-01-25 19:39:50 +01:00
## Members
2014-01-25 19:43:46 +01:00
### Founders
2014-01-25 19:39:50 +01:00
* Pablo Luna <pveiga@wisemapping.com>
* Paulo Veiga <pablo@wisemapping.com>
2014-01-19 22:21:18 +01:00
2014-01-25 19:43:46 +01:00
### Individual Controbutors
2014-01-25 19:47:44 +01:00
* Ezequiel Bergamaschi
2014-01-19 22:21:18 +01:00
2014-01-25 19:43:46 +01:00
### Past Individual Contributors
2014-01-25 19:47:44 +01:00
* Ignacio Manzano
* Nicolas Damonte
2014-01-09 00:28:21 +01:00
2011-01-24 16:23:01 +01:00
## License
The source code is Licensed under the WiseMapping Open License, Version 1.0 (the “License”);
2014-01-09 00:33:00 +01:00
You may obtain a copy of the License at: [https://wisemapping.atlassian.net/wiki/display/WS/License]