wisemapping-open-source/README.md

106 lines
3.1 KiB
Markdown
Raw Permalink 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 11 to 16
* Maven 3.x or higher ([http://maven.apache.org/])
2014-01-09 00:28:21 +01:00
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:
* wise-react: React font-end fetcher
2014-01-09 00:28:21 +01:00
* wise-webapp: J2EE web application
The full compilation of the project can be performed executing within <project-dir>:
`export MAVEN_OPTS="--illegal-access=permit"`
`mvn clean install`
2014-01-09 00:28:21 +01:00
Once this command is executed, the file <project-dir>/wise-webapp/target/wisemapping*.war will be generated.
2014-01-09 00:28:21 +01:00
### Local Development
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/] using file based database.
2014-01-09 00:28:21 +01:00
User: test@wisemapping.org
Password: test
### Local Development - UI Integration
In order to reduce the life-cycle to develop UI backend testing, you can do the following hack:
* Clone [https://bitbucket.org/wisemapping/wisemapping-open-source/] and [https://bitbucket.org/wisemapping/wisemapping-frontend/] at the same top level directory
* Compile `WiseMapping Frontend`
* Compile `WiseMapping Open Source`
* Follow the Local Testing steps.
### Compiling and running with docker-compose
Check out the [docker section](./docker/README.md)
2014-01-25 19:43:46 +01:00
## Running the JS only version
Start by creating the .zip file.
2014-01-25 19:43:46 +01:00
`mvn assembly:assembly -Dmaven.test.skip=true`
To test the javascript frontend, install a simple http-server.
2014-01-25 19:43:46 +01:00
`npm install -g http-server`
2014-01-25 19:43:46 +01:00
Now open a browser using the URL http://localhost:8080/wise-editor/src/main/webapp/
2014-01-25 19:43:46 +01:00
## Troubleshooting
<details>
<summary>
<code>mvn package</code> fails with the error <code>java.lang.UnsatisfiedLinkError: Can't load library: /usr/lib/jvm/java-11-openjdk-amd64/lib/libawt_xawt.so</code> in Ubuntu
</summary>
Make sure you have the jdk installed: `sudo apt-get install openjdk-11-jdk`
</details>
<details>
<summary><code>mvn package</code> does not generate the wisemapping.war file </summary>
Run `mvn clean install -DskipTests`
</details>
2018-09-16 21:29:19 +02:00
## Maintenance
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
* Paulo Veiga <pablo@wisemapping.com>
* Pablo Luna <pveiga@wisemapping.com>
2014-01-19 22:21:18 +01:00
### Individual Contributors
2014-01-25 19:43:46 +01:00
2014-01-30 05:47:14 +01:00
* Ezequiel Bergamaschi <ezequielbergamaschi@gmail.com>
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
* Claudio Barril <claudiobarril@gmail.com>
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]
2018-09-16 21:29:19 +02:00