wisemapping-open-source/README.md

75 lines
2.5 KiB
Markdown
Raw Normal View History

2022-01-05 15:02:06 +01:00
# Overview
2011-01-24 16:23:01 +01:00
2022-01-05 15:02:06 +01:00
WiseMapping is a free web based *mind map* product. The goal of this project is to provide a high quality product that can be deployed by enterprises, educational and academic institutions.
WiseMapping is based on the same code product supporting http://www.wisemapping.com.
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:
* OpenJDK 11 or higher
* 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:
2022-01-05 06:14:14 +01:00
* wise-ui: 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>:
`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:
2022-01-11 02:01:40 +01:00
* Clone [wisemapping-open-source](https://bitbucket.org/wisemapping/wisemapping-open-source/) and [wisemapping-frontend](https://bitbucket.org/wisemapping/wisemapping-frontend/) at the same top level directory
* Compile `wisemapping-frontend`. Details for compilation can be found in the `wisemapping-frontend` readme.
* Compile `wisemapping-open-source`
A quick and dirty solution to share changes in the UI is to manually compile the dist. This will make the loader file available without the need to publish:
`cp -r wisemapping-frontend/packages/mindplot/dist/* wisemapping-open-source/wise-ui/target/wisemapping-mindplot/package/dist`
### Compiling and running with docker-compose
2022-01-05 06:14:14 +01:00
Check out the [docker section](./docker/README.
2014-01-25 19:39:50 +01:00
## Members
2014-01-25 19:43:46 +01:00
### Founders
2022-01-11 02:04:35 +01:00
* Paulo Veiga <pveiga@wisemapping.com>
* Pablo Luna <pablo@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
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