mirror of
https://bitbucket.org/wisemapping/wisemapping-open-source.git
synced 2024-11-22 06:07:57 +01:00
Merge github.com:wisemapping/wise-source.wiki
This commit is contained in:
commit
9c56f9e40a
34
Compiling-and-running.md
Normal file
34
Compiling-and-running.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
# Compiling and Running
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
The following products must be installed:
|
||||||
|
|
||||||
|
* Java Development Kit 6 or higher (http://java.sun.com/javase/downloads/index.jsp)
|
||||||
|
* Maven 2.2.1 or higher (http://maven.apache.org/)
|
||||||
|
|
||||||
|
## Compiling
|
||||||
|
|
||||||
|
WiseMapping uses Maven as packaging and project management. The project is composed of 4 maven sub-modules:
|
||||||
|
|
||||||
|
* core-js: Utilities JavaScript libraries
|
||||||
|
* web2d: JavaScript 2D VML/SVG abstraction library used by the mind map editor
|
||||||
|
* mindplot: JavaScript mind map designer core
|
||||||
|
* wise-webapp: J2EE web application
|
||||||
|
|
||||||
|
Full compilation of the project can be done executing within <project-dir>:
|
||||||
|
|
||||||
|
`mvn install`
|
||||||
|
|
||||||
|
Once this command is execute, the file <project-dir>/wise-webapp/target/wisemapping.war will be generated.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
The previously generated war can be deployed locally executing within the directory <project-dir>/wise-webapp the following command:
|
||||||
|
|
||||||
|
`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
|
53
Documentation.textile
Normal file
53
Documentation.textile
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
h1. Documentation
|
||||||
|
|
||||||
|
h2. Architecture
|
||||||
|
|
||||||
|
WiseMapping has been development mainly in Java and JavaScript. The following diagram represents a high level overview of the product
|
||||||
|
[[http://www.wisemapping.org/_/rsrc/1257718018304/documentation/architecture/Wise%20Editor%20Architecture.png]]
|
||||||
|
|
||||||
|
h2. Configuration
|
||||||
|
|
||||||
|
h3. DataBase
|
||||||
|
|
||||||
|
Wisemapping support a wide variety of databases, but we provide the Database’s script initialization for HSQL and MySQL Database. The initialization script are located within <WISEMAPPING_SOURCE_DIR>\trunk\wise-webapp\src\test\sql.
|
||||||
|
|
||||||
|
This directory contains the following 3 scripts::
|
||||||
|
create-schemas.sql: Contains all the SQL statement to create the Wisemapping’s tables.
|
||||||
|
drop-schemas.sql:Contains all the SQL statement to drop all the Wisemapping database.
|
||||||
|
test-data.sql: This script creates a sample data and the test user called test@wisemapping.com and password test.
|
||||||
|
MySQL
|
||||||
|
|
||||||
|
h4. Create Database User
|
||||||
|
|
||||||
|
Using the MySQL Databse Tools run the following command in order to create the database user.
|
||||||
|
|
||||||
|
CREATE DATABASE wisemapping CHARACTER SET='utf8' COLLATE='utf8_unicode_ci';
|
||||||
|
CREATE USER 'wisemapping'@'localhost' IDENTIFIED BY 'd0ndu3nd3';
|
||||||
|
GRANT ALL ON wisemapping.* TO 'wisemapping'@'localhost';
|
||||||
|
|
||||||
|
h3. Configuration
|
||||||
|
|
||||||
|
You can configure Wisemapping through the following file:
|
||||||
|
|
||||||
|
wise-webapp\src\main\webapp\WEB-INF\app.properties.
|
||||||
|
|
||||||
|
This property file contains all the properties to configure the database, mail and other resources used by Wisemapping.
|
||||||
|
|
||||||
|
Property -> Description
|
||||||
|
* database.url -> The Database URL(Ex. dbc:hsqldb:file:target/db/wisemapping)
|
||||||
|
* database.driver-> The Database Driver.(Ex. org.hsqldb.jdbcDriver)
|
||||||
|
* database.hibernate.dialect -> The Database dialect. This value is used by Spring DB.(Ex. org.hibernate.dialect.HSQLDialect)
|
||||||
|
* database.username -> The database username
|
||||||
|
* database.password -> The database password
|
||||||
|
* mail.smtp.socketFactory.port -> The mail port to send email
|
||||||
|
* mail.host -> The email server host
|
||||||
|
* mail.user -> The mail username
|
||||||
|
* mail.password -> The mail password
|
||||||
|
* mail.registrationEmail -> The email used as FROM in the registration emails.
|
||||||
|
* mail.siteEmail -> The email used as FROM in the notification emails.
|
||||||
|
|
||||||
|
h3. Logging Properties
|
||||||
|
|
||||||
|
WiseMapping uses Log4J to log all the events. The configuration file is located in :
|
||||||
|
|
||||||
|
<WISEMAPPING_DIR>\wise-webapp\src\main\webapp\WEB-INF\classes
|
11
Faq.textile
Normal file
11
Faq.textile
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
h1. FAQ
|
||||||
|
|
||||||
|
h2. Which technology is being used to render the mind maps?
|
||||||
|
|
||||||
|
We use SVG for Firefox and Safari, and VML for IE and Opera.
|
||||||
|
|
||||||
|
SVG (Scalable Vectorial Graphics) allows straightforward and efficient vector graphics animation and VML (Vector Markup Language) supports the markup of vector graphic information in the same way that HTML supports the markup of textual information.
|
||||||
|
|
||||||
|
h2. What's the source code License?
|
||||||
|
|
||||||
|
http://www.wisemapping.org/license
|
21
Home.textile
Normal file
21
Home.textile
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
h1. What is WiseMapping Open Source?
|
||||||
|
|
||||||
|
WiseMapping is a free web based mindmapping application. 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.
|
||||||
|
|
||||||
|
h1. Why Open Source ?
|
||||||
|
|
||||||
|
In the last years, we have received hundred of mails from different persons asking for:
|
||||||
|
Integrating wisemapping.com with their sites
|
||||||
|
Deploying a private instance of wisemapping.com
|
||||||
|
Participating in the development of the site
|
||||||
|
All this make us wonder "Why if we share our product to all this people and invite them to participate with us in this journey ?" .
|
||||||
|
|
||||||
|
h1. Who are we ?
|
||||||
|
|
||||||
|
We’re a couple of friends working on an idea: “Create the best on-line collaborative mind mapping tool ever created”. This has been our idea since the first day we started.
|
||||||
|
|
||||||
|
h1. [[Documentation]]
|
||||||
|
|
||||||
|
h1. [[Compiling and Running]]
|
||||||
|
|
||||||
|
h1. [[FAQ]]
|
Loading…
Reference in New Issue
Block a user