From fa2497f0c63855545b68b29b53d35b17406bf6f2 Mon Sep 17 00:00:00 2001 From: Marko Gronroos Date: Thu, 17 Mar 2016 15:58:58 +0200 Subject: Reorganized the Getting Started chapter to separate installation and project creation chapters. #19639 Change-Id: I4aab29b8b9ab23091903016e9cc91850c4ca3b93 --- .../installing/chapter-installing.asciidoc | 20 + documentation/installing/img/firebug.png | Bin 0 -> 59376 bytes documentation/installing/img/idea-server-1.png | Bin 0 -> 10365 bytes documentation/installing/img/idea-server-2.png | Bin 0 -> 36365 bytes .../installing/img/installation-eclipse-hi.png | Bin 0 -> 64185 bytes .../installing/img/installation-netbeans-hi.png | Bin 0 -> 34582 bytes .../installing/img/installation-steps-hi.png | Bin 0 -> 65439 bytes .../installing/img/installing-netbeans-1.png | Bin 0 -> 49371 bytes .../installing/img/installing-netbeans-2.png | Bin 0 -> 75999 bytes .../installing/img/installing-netbeans-3.png | Bin 0 -> 41441 bytes .../installing/img/installing-netbeans-4.png | Bin 0 -> 40150 bytes .../installing/img/installing-netbeans-5.png | Bin 0 -> 47869 bytes .../img/installing-netbeans-plugin-1.png | Bin 0 -> 52690 bytes .../img/installing-netbeans-plugin-2.png | Bin 0 -> 21920 bytes .../img/installing-netbeans-plugin-3.png | Bin 0 -> 35024 bytes .../installing/img/plugin-install-addsite.png | Bin 0 -> 14375 bytes .../installing/img/plugin-install-available.png | Bin 0 -> 52009 bytes documentation/installing/img/toolchain-hi.png | Bin 0 -> 227400 bytes documentation/installing/img/toolchain-lo.png | Bin 0 -> 58261 bytes documentation/installing/installing-eclipse.adoc | 135 + documentation/installing/installing-idea.asciidoc | 54 + documentation/installing/installing-java.adoc | 72 + .../installing/installing-netbeans.asciidoc | 112 + documentation/installing/installing-other.adoc | 38 + documentation/installing/installing-overview.adoc | 28 + documentation/installing/installing-server.adoc | 44 + documentation/installing/installing-toolchain.adoc | 41 + .../installing/original-drawings/Makefile | 13 + .../original-drawings/installation-eclipse.svg | 536 ++ .../original-drawings/installation-netbeans.svg | 334 + .../installation-steps-constellation.svg | 7259 ++++++++++++++++++++ .../original-drawings/installation-steps.svg | 664 ++ .../original-drawings/steps-constellation.png | Bin 0 -> 55123 bytes .../original-drawings/steps-constellation.svg | 6812 ++++++++++++++++++ .../installing/original-drawings/toolchain.svg | 1149 ++++ 35 files changed, 17311 insertions(+) create mode 100644 documentation/installing/chapter-installing.asciidoc create mode 100644 documentation/installing/img/firebug.png create mode 100644 documentation/installing/img/idea-server-1.png create mode 100644 documentation/installing/img/idea-server-2.png create mode 100644 documentation/installing/img/installation-eclipse-hi.png create mode 100644 documentation/installing/img/installation-netbeans-hi.png create mode 100644 documentation/installing/img/installation-steps-hi.png create mode 100644 documentation/installing/img/installing-netbeans-1.png create mode 100644 documentation/installing/img/installing-netbeans-2.png create mode 100644 documentation/installing/img/installing-netbeans-3.png create mode 100644 documentation/installing/img/installing-netbeans-4.png create mode 100644 documentation/installing/img/installing-netbeans-5.png create mode 100644 documentation/installing/img/installing-netbeans-plugin-1.png create mode 100644 documentation/installing/img/installing-netbeans-plugin-2.png create mode 100644 documentation/installing/img/installing-netbeans-plugin-3.png create mode 100644 documentation/installing/img/plugin-install-addsite.png create mode 100644 documentation/installing/img/plugin-install-available.png create mode 100644 documentation/installing/img/toolchain-hi.png create mode 100644 documentation/installing/img/toolchain-lo.png create mode 100644 documentation/installing/installing-eclipse.adoc create mode 100644 documentation/installing/installing-idea.asciidoc create mode 100644 documentation/installing/installing-java.adoc create mode 100644 documentation/installing/installing-netbeans.asciidoc create mode 100644 documentation/installing/installing-other.adoc create mode 100644 documentation/installing/installing-overview.adoc create mode 100644 documentation/installing/installing-server.adoc create mode 100644 documentation/installing/installing-toolchain.adoc create mode 100644 documentation/installing/original-drawings/Makefile create mode 100644 documentation/installing/original-drawings/installation-eclipse.svg create mode 100644 documentation/installing/original-drawings/installation-netbeans.svg create mode 100644 documentation/installing/original-drawings/installation-steps-constellation.svg create mode 100644 documentation/installing/original-drawings/installation-steps.svg create mode 100644 documentation/installing/original-drawings/steps-constellation.png create mode 100644 documentation/installing/original-drawings/steps-constellation.svg create mode 100644 documentation/installing/original-drawings/toolchain.svg (limited to 'documentation/installing') diff --git a/documentation/installing/chapter-installing.asciidoc b/documentation/installing/chapter-installing.asciidoc new file mode 100644 index 0000000000..7e987bcea8 --- /dev/null +++ b/documentation/installing/chapter-installing.asciidoc @@ -0,0 +1,20 @@ +[[installing]] +== Installing the Development Toolchain + +This chapter gives practical instructions for installing the development tools. + +include::installing-overview.adoc[leveloffset=+2] + +include::installing-toolchain.adoc[leveloffset=+2] + +include::installing-java.adoc[leveloffset=+2] + +include::installing-server.adoc[leveloffset=+2] + +include::installing-eclipse.adoc[leveloffset=+2] + +include::installing-netbeans.asciidoc[leveloffset=+2] + +include::installing-idea.asciidoc[leveloffset=+2] + +include::installing-other.adoc[leveloffset=+2] diff --git a/documentation/installing/img/firebug.png b/documentation/installing/img/firebug.png new file mode 100644 index 0000000000..81512b615d Binary files /dev/null and b/documentation/installing/img/firebug.png differ diff --git a/documentation/installing/img/idea-server-1.png b/documentation/installing/img/idea-server-1.png new file mode 100644 index 0000000000..f0e0fb7f9b Binary files /dev/null and b/documentation/installing/img/idea-server-1.png differ diff --git a/documentation/installing/img/idea-server-2.png b/documentation/installing/img/idea-server-2.png new file mode 100644 index 0000000000..2375f44c48 Binary files /dev/null and b/documentation/installing/img/idea-server-2.png differ diff --git a/documentation/installing/img/installation-eclipse-hi.png b/documentation/installing/img/installation-eclipse-hi.png new file mode 100644 index 0000000000..cf2b4efb04 Binary files /dev/null and b/documentation/installing/img/installation-eclipse-hi.png differ diff --git a/documentation/installing/img/installation-netbeans-hi.png b/documentation/installing/img/installation-netbeans-hi.png new file mode 100644 index 0000000000..c0a54f544f Binary files /dev/null and b/documentation/installing/img/installation-netbeans-hi.png differ diff --git a/documentation/installing/img/installation-steps-hi.png b/documentation/installing/img/installation-steps-hi.png new file mode 100644 index 0000000000..06089e1e46 Binary files /dev/null and b/documentation/installing/img/installation-steps-hi.png differ diff --git a/documentation/installing/img/installing-netbeans-1.png b/documentation/installing/img/installing-netbeans-1.png new file mode 100644 index 0000000000..c2edcae32e Binary files /dev/null and b/documentation/installing/img/installing-netbeans-1.png differ diff --git a/documentation/installing/img/installing-netbeans-2.png b/documentation/installing/img/installing-netbeans-2.png new file mode 100644 index 0000000000..b3d0a07e03 Binary files /dev/null and b/documentation/installing/img/installing-netbeans-2.png differ diff --git a/documentation/installing/img/installing-netbeans-3.png b/documentation/installing/img/installing-netbeans-3.png new file mode 100644 index 0000000000..63a59df0d7 Binary files /dev/null and b/documentation/installing/img/installing-netbeans-3.png differ diff --git a/documentation/installing/img/installing-netbeans-4.png b/documentation/installing/img/installing-netbeans-4.png new file mode 100644 index 0000000000..a3c03eb0ca Binary files /dev/null and b/documentation/installing/img/installing-netbeans-4.png differ diff --git a/documentation/installing/img/installing-netbeans-5.png b/documentation/installing/img/installing-netbeans-5.png new file mode 100644 index 0000000000..345bffc12e Binary files /dev/null and b/documentation/installing/img/installing-netbeans-5.png differ diff --git a/documentation/installing/img/installing-netbeans-plugin-1.png b/documentation/installing/img/installing-netbeans-plugin-1.png new file mode 100644 index 0000000000..45b69f626b Binary files /dev/null and b/documentation/installing/img/installing-netbeans-plugin-1.png differ diff --git a/documentation/installing/img/installing-netbeans-plugin-2.png b/documentation/installing/img/installing-netbeans-plugin-2.png new file mode 100644 index 0000000000..9c695de0d9 Binary files /dev/null and b/documentation/installing/img/installing-netbeans-plugin-2.png differ diff --git a/documentation/installing/img/installing-netbeans-plugin-3.png b/documentation/installing/img/installing-netbeans-plugin-3.png new file mode 100644 index 0000000000..8eecbb7624 Binary files /dev/null and b/documentation/installing/img/installing-netbeans-plugin-3.png differ diff --git a/documentation/installing/img/plugin-install-addsite.png b/documentation/installing/img/plugin-install-addsite.png new file mode 100644 index 0000000000..baa36c5416 Binary files /dev/null and b/documentation/installing/img/plugin-install-addsite.png differ diff --git a/documentation/installing/img/plugin-install-available.png b/documentation/installing/img/plugin-install-available.png new file mode 100644 index 0000000000..d9c305de62 Binary files /dev/null and b/documentation/installing/img/plugin-install-available.png differ diff --git a/documentation/installing/img/toolchain-hi.png b/documentation/installing/img/toolchain-hi.png new file mode 100644 index 0000000000..88d9dfcc4c Binary files /dev/null and b/documentation/installing/img/toolchain-hi.png differ diff --git a/documentation/installing/img/toolchain-lo.png b/documentation/installing/img/toolchain-lo.png new file mode 100644 index 0000000000..e42b94bc2f Binary files /dev/null and b/documentation/installing/img/toolchain-lo.png differ diff --git a/documentation/installing/installing-eclipse.adoc b/documentation/installing/installing-eclipse.adoc new file mode 100644 index 0000000000..244a2a7b7d --- /dev/null +++ b/documentation/installing/installing-eclipse.adoc @@ -0,0 +1,135 @@ +--- +title: Installing Eclipse IDE +order: 100 +layout: page +--- + +[[installing.eclipse]] += Installing the Eclipse IDE and Plugin + +If you are using the Eclipse IDE, using the Vaadin Plugin for Eclipse helps +greatly. The plugin includes wizards for creating new Vaadin-based projects, +themes, and client-side widgets and widget sets. Notice that you can also create +Vaadin projects as Maven projects in Eclipse. + +Using Eclipse IDE for Vaadin development requires installing the IDE itself and the Vaadin Plugin for Eclipse. +You are adviced to also configure a web server in Eclipse. +You can then use the server for running the Vaadin applications that you create. + +.Installation of the Eclipse IDE toolchain +image::img/installation-eclipse-hi.png[] + +Vaadin Designer is a visual design tool for professional developers. +It allows for easy creation of declarative designs. +It is also good as a sketching tool, as well as an easy way to learn about Vaadin components and layouts. + +Once you have installed the Eclipse IDE and the plug-in, you can create a Vaadin application project as described in <>. + +[[installing.eclipse.ide]] +== Installing the Eclipse IDE + +=== Windows + +. Download the Eclipse IDE for Java EE Developers from +link:http://www.eclipse.org/downloads/[http://www.eclipse.org/downloads/] + +. Decompress the Eclipse IDE package to a suitable directory. +You are free to select any directory and to use any ZIP decompressor, but in this example we decompress the ZIP file by just double-clicking it and selecting "Extract all files" task from Windows compressed folder task. +In our installation example, we use [filename]#C:\dev# as the target directory. + +Eclipse is now installed in [filename]#C:\dev\eclipse#. +You can start it from there by double clicking [filename]#eclipse.exe#. + +=== Linux / OS X / UNIX + +We recommend that you install Eclipse manually in Linux and other UNIX variants. +They may have it available from a package repository, but using such an installation may cause problems with installing plug-ins. + +You can install Eclipse as follows: + +. Download Eclipse IDE for Java EE Developers from +link:http://www.eclipse.org/downloads/[http://www.eclipse.org/downloads/] + +. Decompress the Eclipse package into a suitable base directory. +It is important to make sure that there is no old Eclipse installation in the target directory. +Installing a new version on top of an old one probably renders Eclipse unusable. + +. Eclipse should normally be installed as a regular user, which makes installation of plug-ins easier. +Eclipse also stores some user settings in the installation directory. ++ +To install the package, enter: ++ +[subs="normal"] +---- +[prompt]#$# [command]#tar# zxf [replaceable]####/eclipse-jee-[replaceable]####.tar.gz +---- ++ +This will extract the package to a subdirectory with the name +[filename]#eclipse#. + +. If you wish to enable starting Eclipse from command-line, you need to add the +Eclipse installation directory to your system or user PATH, or make a symbolic +link or script to point to the executable. + +An alternative to the above procedure would be to use an Eclipse version +available through the package management system of your operating system. It is, +however, __not recommended__, because you will need write access to the Eclipse +installation directory to install Eclipse plugins, and you may face +incompatibility issues with Eclipse plugins installed by the package management +of the operating system. + +[[installing.eclipse.plugin]] +== Installing the Vaadin Plugin + +You can install the plugin as follows: + +. Select "Help > Install New Software...". + +. Add the Vaadin plugin update site by clicking [guibutton]#Add...# button. + ++ +image::img/plugin-install-addsite.png[] + ++ +Enter a name such as "Vaadin Update Site" and the URL of the update site: +http://vaadin.com/eclipse. If you want or need to use the latest unstable +plugin, which is usually more compatible with development and beta releases of +Vaadin, you can use http://vaadin.com/eclipse/experimental and give it a +distinctive name such as "Vaadin Experimental Site". Then click [guibutton]#OK#. +The Vaadin site should now appear in the [guilabel]#Available Software# window. + +. Currently, if using the stable plugin, the [guilabel]#Group items by category# should be enabled. If using the experimental plugin, it should be disabled. This may change in future. + +. Select all the Vaadin plugins in the tree. ++ +image::img/plugin-install-available.png[] ++ +Then, click [guibutton]#Next#. + +. Review the installation details and click [guibutton]#Next#. + +. Accept or unaccept the license. Finally, click [guibutton]#Finish#. + +. After the plugin is installed, Eclipse will ask to restart itself. Click +[guibutton]#Restart#. + +More installation instructions for the Eclipse plugin can be found at +http://vaadin.com/eclipse. + +[[installing.eclipse.update]] +== Updating the Plugins + +If you have automatic updates enabled in Eclipse (see "Window > Preferences > +Install/Update > Automatic Updates"), the Vaadin plugin will be updated +automatically along with other plugins. Otherwise, you can update the Vaadin +plugin manually as follows: + +. Select "Help > Check for Updates". +Eclipse will contact the update sites of the installed software. + +. After the updates are installed, Eclipse will ask to restart itself. +Click [guibutton]#Restart#. + +Notice that updating the Vaadin plugin only updates the plugin and __not__ the +Vaadin libraries, which are project specific. See below for instructions for +updating the libraries. diff --git a/documentation/installing/installing-idea.asciidoc b/documentation/installing/installing-idea.asciidoc new file mode 100644 index 0000000000..95779dab55 --- /dev/null +++ b/documentation/installing/installing-idea.asciidoc @@ -0,0 +1,54 @@ +--- +title: Installing IntelliJ IDEA +order: 120 +layout: page +--- + +[[intalling.idea]] += Installing and Configuring IntelliJ IDEA + +With IntelliJ IDEA, you have two choices: use the commercial Ultimate Edition or the free Community Edition. +In the following, we cover the installation and configuration of them both. + +The Ultimate Edition:: +The Ultimate Edition includes built-in support for creating Vaadin applications and running or debugging them in an integrated application server. + +Community Edition:: +You can create a Vaadin application most easily with a Maven archetype and deploy it to a server using a Maven run/debug configuration. + +You can get the both editions from the website at https://www.jetbrains.com/idea/[jetbrains.com/idea]. + +[[installing.idea.ultimate]] +== Installing the Ultimate Edition + +Follow the installation instructions given at the website. + +[[installing.idea.ultimate.server]] +=== Configuring an Application Server + +To run a Vaadin application during development in the Ultimate Edition of IntelliJ IDEA, you first need to install and configure an application server that is integrated with the IDE. +The edition includes integration with many commonly used application servers. + +In the following, we configure Apache Tomcat: + +. Download and extract Tomcat installation package to a local directory, as +instructed in <>. + +. Select "Configure > Settings". + +. Select "IDE Settings > Application Servers". + +. Click [guibutton]#+# and select [guilabel]#Tomcat Server# to add a Tomcat server, or any of the other supported servers. +A WebSocket-enabled server, such as Glassfish or TomEE, is required for server push. + +. In the Tomcat Server dialog, specify the home directory for the server. ++ +image::img/idea-server-1.png[] ++ +Click [guibutton]#OK#. + +. Review the application server settings page to check that it is OK. ++ +image::img/idea-server-2.png[] ++ +Then, click [guibutton]#OK#. diff --git a/documentation/installing/installing-java.adoc b/documentation/installing/installing-java.adoc new file mode 100644 index 0000000000..adee81c05a --- /dev/null +++ b/documentation/installing/installing-java.adoc @@ -0,0 +1,72 @@ +--- +title: Installing Java +order: 30 +layout: page +--- + +[[installing.java]] += Installing Java SDK + +A Java SDK is required by Vaadin and also by any of the Java IDEs. +Vaadin is compatible with Java 1.6 and later editions, be we recommend using Java 8 for Vaadin development. +Java EE 7 is required for proper server push support with WebSockets. + +[[installing.java.windows]] +== Windows + +Follow the following steps: + +. Download Oracle Java SE 8.0 from +link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[http://www.oracle.com/technetwork/java/javase/downloads/index.html] + +. Install the Java SDK by running the installer. +The default options are fine. + +[[installing.linux]] +== Linux / UNIX + +Most Linux systems either have JDK preinstalled or allow installing it through a +package management system. Notice however that they have OpenJDK as the default +Java implementation. While it is known to have worked with Vaadin and possibly +also with the development toolchain, we do not especially support it. + +Regarding OS X, notice that JDK 1.6 or newer is included in OS X 10.6 and newer. + +Otherwise: + +. Download Oracle Java SE 8.0 from +link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[http://www.oracle.com/technetwork/java/javase/downloads/] + +. Decompress it under a suitable base directory, such as [filename]#/opt#. For +example, for Java SDK, enter (either as root or with [command]#sudo# in Linux): + ++ +[subs="normal"] +---- +[prompt]#+++#+++# [command]#cd# [replaceable]#/opt# +[prompt]#+++#+++# [command]#sh# [replaceable]####/jdk-[replaceable]####.bin +---- ++ +and follow the instructions in the installer. + +. Set up the [literal]#++JAVA_HOME++# environment variable to point to the Java +installation directory. Also, include the [literal]#++$JAVA_HOME/bin++# in the +[literal]#++PATH++#. How you do that varies by the UNIX variant. For example, in +Linux and using the Bash shell, you would add lines such as the following to the +[filename]#.bashrc# or [filename]#.profile# script in your home directory: + ++ +---- +export JAVA_HOME=/opt/jdk1.8.0_31 +export PATH=$PATH:$HOME/bin:$JAVA_HOME/bin +---- ++ +You could also make the setting system-wide in a file such as +[filename]#/etc/bash.bashrc#, [filename]#/etc/profile#, or an equivalent file. +If you install Apache Ant or Maven, you may also want to set up those in the +path. + ++ +Settings done in a [filename]#bashrc# file require that you open a new shell +window. Settings done in a [filename]#profile# file require that you log in into +the system. You can, of course, also give the commands in the current shell. diff --git a/documentation/installing/installing-netbeans.asciidoc b/documentation/installing/installing-netbeans.asciidoc new file mode 100644 index 0000000000..35d7b96c16 --- /dev/null +++ b/documentation/installing/installing-netbeans.asciidoc @@ -0,0 +1,112 @@ +--- +title: Installing NetBeans IDE +order: 110 +layout: page +--- + +[[installing.netbeans]] += Installing the NetBeans IDE and Plugin + +Vaadin offers official support for the NetBeans IDE. +The Vaadin Plug-in for NetBeans supports creating Vaadin projects, updating Vaadin libraries, compiling widget sets, and more. +It also allows directly downloading Vaadin add-ons from the Vaadin Directory. + +.Installation of the NetBeans IDE toolchain +image::img/installation-netbeans-hi.png[width=60%] + +The installation bundle includes a web server, so you do not need that. + +Once done with the installation, you can proceed to create a Vaadin project, as described in <>. + +[[installing.netbeans.ide]] +== Installing the NetBeans IDE + +Download NetBeans IDE from the website at https://netbeans.org/downloads/[netbeans.org]. +We recommend using the _Java EE_ download bundle, which includes support for Java EE, and also both the GlassFish and Tomcat application servers. + +. Run the installer + +.. In OS X and Linux: ++ +[subs="normal"] +---- +[prompt]#$# [command]#sh# [replaceable]#netbeans-.sh# +---- + +. Select to install either GlassFish or Apache Tomcat, or both. +GlassFish supports Java EE, which is required by Vaadin CDI and Vaadin Spring add-ons, while standard Tomcat does not support it. +Click [guibutton]#Next#. +ifdef::web[] ++ +image::img/installing-netbeans-1.png[width=60%] +endif::web[] + +. If you accept the license, click [guibutton]#Next#. + +. Choose installation folder and Java SDK. +ifdef::web[] ++ +image::img/installing-netbeans-3.png[width=60%] +endif::web[] ++ +In OS X and Linux, if you ran the installer with root permissions or can write to [filename]#/opt#, the [filename]#/opt# path is standard for such system-wide packages. ++ +Click [guibutton]#Next#. + +. Choose the folder for installing the server. +ifdef::web[] ++ +image::img/installing-netbeans-4.png[width=60%] +endif::web[] + +. Check the settings. +ifdef::web[] ++ +image::img/installing-netbeans-5.png[width=60%] +endif::web[] ++ +Click [guibutton]#Finish#. +It takes a while to install the NetBeans IDE. + +. Finally, click [guibutton]#Done# to exit the installer. + +You can now start NetBeans by starting the [filename]#bin/netbeans# from under the installation folder. + +In Linux and OS X: + +[subs="normal"] +---- +[prompt]#$# [replaceable]#/opt/netbeans-8.1#/bin/netbeans +---- + +You can now proceed to install the Vaadin Plug-in for NetBeans IDE. + +[[installing.netbeans.plugin]] +== Installing the Vaadin Plug-in for NetBeans IDE + +You can install the plug-in from the NetBeans Plugin Portal Update Center as follows. + +. Select "Tools > Plugins" from the NetBeans main menu. + +. Select the [guilabel]#Available Plugins# tab. +.. Type "Vaadin" in the [guilabel]#Search# box and press kbd:Enter[]. +.. Select the [guilabel]#Install# check box for the [guilabel]#Vaadin Plugin for NetBeans#. +ifdef::web[] ++ +image::img/installing-netbeans-plugin-1.png[width=80%] +endif::web[] + +.. Click [guibutton]#Install#. + +. In the plugin installation window, click [guibutton]#Next#. +. Accept the license if choose to do so. +Click [guibutton]#Install#. + +. The Vaadin Plugin is not signed, so you need to verify the certificate. +Click [guibutton]#Continue#. + +. In the final step, select [guilabel]#Restart IDE now" and click [guibutton]#Finish#. + +You can now proceed to create a Vaadin project, as described in <>. + +The Vaadin Plug-in for NetBeans IDE can also be downloaded from the plug-in page at http://plugins.netbeans.org/plugin/50531/vaadin-plug-in-for-netbeans[plugins.netbeans.org/plugin/50531/vaadin-plug-in-for-netbeans]. diff --git a/documentation/installing/installing-other.adoc b/documentation/installing/installing-other.adoc new file mode 100644 index 0000000000..b7ff51dfea --- /dev/null +++ b/documentation/installing/installing-other.adoc @@ -0,0 +1,38 @@ +--- +title: Installing Other Tools +order: 200 +layout: page +--- + += Installing Other Tools + +We recommend using a browser with either integrated or external development tools. + +At least Mozilla Firefox and Google Chrome have an integrated web inspector, which supports inspecting the DOM structure of a web page, as well as CSS styles and debug JavaScript execution. + +[[installing.other.firefox]] +== Firefox and Firebug + +While Firefox has an integrated web inspector, the Firebug inspector has some additional features. + +[[installing.other.firefox.firebug]] +=== Using Firebug with Vaadin + +After installing Firefox, use it to open +link:http://www.getfirebug.com/[http://www.getfirebug.com/]. Follow the +instructions on the site to install the latest stable version of Firebug +available for the browser. You may need to allow Firefox to install the plugin +by clicking the yellow warning bar at the top of the browser window. + +After Firebug is installed, it can be enabled at any time from the Firefox +toolbar. <> shows Firebug in action. + +[[figure.firebug.calc]] +.Firebug Debugger for Firefox +image::img/firebug.png[] + +The most important feature in Firebug is inspecting HTML elements. Right-click +on an element and select [guilabel]#Inspect Element with Firebug# to inspect it. +In addition to HTML tree, it also shows the CSS rules matching the element, +which you can use for building themes. You can even edit the CSS styles live, to +experiment with styling. diff --git a/documentation/installing/installing-overview.adoc b/documentation/installing/installing-overview.adoc new file mode 100644 index 0000000000..7075c10172 --- /dev/null +++ b/documentation/installing/installing-overview.adoc @@ -0,0 +1,28 @@ +--- +title: Overview +order: 1 +layout: page +--- + +[[installing.overview]] += Overview + +You can develop Vaadin applications in essentially any development environment +that has the Java SDK and deploys to a Java Servlet container. +You can use Vaadin with any Java IDE or no IDE at all. +Vaadin has special support for the Eclipse and NetBeans IDEs, as well as for IntelliJ IDEA. + +.Vaadin installation steps +image::img/installation-steps-hi.png[] + +Managing Vaadin and other Java libraries can get tedious to do manually, so using a build system that manages dependencies automatically is adviced. +Vaadin is distributed in the Maven central repository, and can be used with any build or dependency management system that can access Maven repositories, such as Ivy or Gradle, in addition to Maven. + +Vaadin has a multitude of installation options for different IDEs and dependency +managers. +You can also install it from an installation package: + +* With the Eclipse IDE, use the Vaadin Plugin for Eclipse, as described in <> +* With the Vaadin plugin for NetBeans IDE ( <>) or IntelliJ IDEA +* With Maven, Ivy, Gradle, or other Maven-compatible dependency manager, under Eclipse, NetBeans, IDEA, or using command-line, as described in <> +* From installation package without dependency management, as described in <> diff --git a/documentation/installing/installing-server.adoc b/documentation/installing/installing-server.adoc new file mode 100644 index 0000000000..59874ab154 --- /dev/null +++ b/documentation/installing/installing-server.adoc @@ -0,0 +1,44 @@ +--- +title: Installing a Web Server +order: 40 +layout: page +--- + +[[installing.server]] += Installing a Web Server + +You can run Vaadin applications in any Java servlet container that supports at least Servlet API 2.4. +However, a server supporting Servlet API 3.0 is recommended. +It is required for using Vaadin CDI, for which also a CDI container is required, a standard feature in Java EE 6 or newer servers. +It is also required by the Vaadin Spring add-on. +Server push can benefit from using communication modes, such as WebSocket, enabled by features in some latest servers. +For Java EE containers, at least Wildfly, Glassfish, and Apache TomEE Web Profile are recommended. + +Also, if you use Java 8 for Vaadin development, you need to make sure that the server supports it. + +Some Java IDEs have server integration, so we describe installation of the server before the IDEs. + +Some IDE bundles also include a development server; for example, NetBeans IDE includes GlassFish and Apache Tomcat. + +You can also opt to install a development server from a Maven dependency and let the IDE control it through Maven executions. + +[[installing.server.tomcat]] +== Installing Apache Tomcat + +Apache Tomcat is a lightweight Java web server suitable for both development and +production. There are many ways to install it, but here we simply decompress the +installation package. + +__Apache Tomcat should be installed with user permissions.__ +During development, you will be running Eclipse or some other IDE with user permissions, but deploying web applications to a Tomcat server that is installed system-wide requires administrator or root permissions. + +. Download the installation package: ++ +Apache Tomcat 8.0 (Core Binary Distribution) from http://tomcat.apache.org/ + +. Decompress Apache Tomcat package to a suitable target directory, such as +[filename]#C:\dev# (Windows) or [filename]#/opt# (Linux or Mac OS X). +The Apache Tomcat home directory will be [filename]#C:\dev\apache-tomcat-8.0.x# or [filename]#/opt/apache-tomcat-8.0.x#, respectively. + +Do not start the server. +If you use an IDE integration, the IDE will control starting and stopping the server. diff --git a/documentation/installing/installing-toolchain.adoc b/documentation/installing/installing-toolchain.adoc new file mode 100644 index 0000000000..08ad190a8d --- /dev/null +++ b/documentation/installing/installing-toolchain.adoc @@ -0,0 +1,41 @@ +--- +title: A Reference Toolchain +order: 20 +layout: page +--- + +[[getting-started.environment]] += A Reference Toolchain + +This section presents a reference development environment. +Vaadin supports a wide variety of tools, so you can use any IDE for writing the code, almost any Java web server for deploying the application, most web browsers for using it, and any operating system platform supported by Java. + +In this example, we use the following toolchain: + +* Windows, Linux, or Mac OS X +* link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[Oracle Java SE 8] (Java 6 or newer is required) +* link:http://www.eclipse.org/downloads/[Eclipse IDE for Java EE Developers] +* link:http://tomcat.apache.org/[Apache Tomcat 8.0 (Core)] +* link:http://www.getfirefox.com/[Mozilla Firefox] browser +* link:http://www.getfirebug.com/[Firebug] debug tool (optional) +* link:http://vaadin.com/download/[Vaadin Framework] + +The above reference toolchain is a good choice of tools, but you can use almost +any tools you are comfortable with. + +We recommend using Java 8 for Vaadin development, but you need to make sure that +your entire toolchain supports it. + +[[figure.toolchain]] +.Development Toolchain and Process +image::img/toolchain-hi.png[width=70%] + +<> illustrates the development toolchain. You develop your +application as an Eclipse project. The project must include, in addition to your +source code, the Vaadin libraries. It can also include project-specific themes. + +You need to compile and deploy a project to a web container before you can use +it. You can deploy a project through the Web Tools Platform (WTP) for Eclipse +(included in the Eclipse EE package), which allows automatic deployment of web +applications from Eclipse. You can also deploy a project manually, by creating a +web application archive (WAR) and deploying it to the web container. diff --git a/documentation/installing/original-drawings/Makefile b/documentation/installing/original-drawings/Makefile new file mode 100644 index 0000000000..44e9b07461 --- /dev/null +++ b/documentation/installing/original-drawings/Makefile @@ -0,0 +1,13 @@ +IMAGES = installation-steps installation-eclipse installation-netbeans + +SRCIMAGES := $(foreach file, $(IMAGES), $(file).svg) +TRGIMAGES_HI := $(foreach file, $(IMAGES), ../img/$(file)-hi.png) +TRGIMAGES_LO := $(foreach file, $(IMAGES), ../img/$(file)-lo.png) + +images: $(TRGIMAGES_HI) FORCE +# Just do low now $(TRGIMAGES_LO) + +$(TRGIMAGES_HI): ../img/%-hi.png: %.svg + inkscape --export-png $@ --export-dpi=150 --export-area-drawing $< + +FORCE: diff --git a/documentation/installing/original-drawings/installation-eclipse.svg b/documentation/installing/original-drawings/installation-eclipse.svg new file mode 100644 index 0000000000..40baf66dd5 --- /dev/null +++ b/documentation/installing/original-drawings/installation-eclipse.svg @@ -0,0 +1,536 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + OnWindows + + + OnOS X + + + OnLinux + + + + + + + InstallEclipse + + + + + + + + Install theVaadin Plugin + Install Vaadin Designer + + + + + ApacheTomcat + + + TomEE + + + Wildfly + + + GlassFish + + + Other + + + + + + Configurea Server + + GoCreate a Project + StartHere + diff --git a/documentation/installing/original-drawings/installation-netbeans.svg b/documentation/installing/original-drawings/installation-netbeans.svg new file mode 100644 index 0000000000..d1f66a3852 --- /dev/null +++ b/documentation/installing/original-drawings/installation-netbeans.svg @@ -0,0 +1,334 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + OnWindows + + + OnOS X + + + OnLinux + + + + + + + InstallNetBeans + + + + + + + + Install theVaadin Plugin + + GoCreate a Project + StartHere + diff --git a/documentation/installing/original-drawings/installation-steps-constellation.svg b/documentation/installing/original-drawings/installation-steps-constellation.svg new file mode 100644 index 0000000000..7716b64f6c --- /dev/null +++ b/documentation/installing/original-drawings/installation-steps-constellation.svg @@ -0,0 +1,7259 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + On Windows On OS X On Linux InstallJDK Eclipse NetBeans IntelliJ IDEA Install an IDE Install aServer InstallVaadinPlugin FireBug ApacheTomcat TomEE GlassFish Other δ γ β α ε InstallOtherTools + M103 M52 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/installing/original-drawings/installation-steps.svg b/documentation/installing/original-drawings/installation-steps.svg new file mode 100644 index 0000000000..2af7752bd3 --- /dev/null +++ b/documentation/installing/original-drawings/installation-steps.svg @@ -0,0 +1,664 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + OnWindows + + + OnOS X + + + OnLinux + + + + + + + InstallJDK + + + + + EclipseIDE + + + NetBeansIDE + + + IntelliJIDEA + + + + + + Install an IDE + + + + ApacheTomcat + + + TomEE + + + Wildfly + + + GlassFish + + + Other + + + + + + Install aServer + + + + Firebug + + + + + + + Other Tools + + + GoCreate a Project + StartHere + diff --git a/documentation/installing/original-drawings/steps-constellation.png b/documentation/installing/original-drawings/steps-constellation.png new file mode 100644 index 0000000000..5e760d6fbe Binary files /dev/null and b/documentation/installing/original-drawings/steps-constellation.png differ diff --git a/documentation/installing/original-drawings/steps-constellation.svg b/documentation/installing/original-drawings/steps-constellation.svg new file mode 100644 index 0000000000..33cc6ec4a0 --- /dev/null +++ b/documentation/installing/original-drawings/steps-constellation.svg @@ -0,0 +1,6812 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + You Are Here + FireBug Apache Tomcat TomEE Wildfly GlassFish Other + + + + + + + + + + + + + + + + + + + + + + + + + + + Windows OS χ Linux InstallJDK Eclipse NetBeans IntelliJ IDEA Install an IDE Install aServer InstallOtherTools Start Here FireBug + diff --git a/documentation/installing/original-drawings/toolchain.svg b/documentation/installing/original-drawings/toolchain.svg new file mode 100644 index 0000000000..63148883f3 --- /dev/null +++ b/documentation/installing/original-drawings/toolchain.svg @@ -0,0 +1,1149 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + User Project Developer Tools + + + + Eclipse IDE (optional) + + + Java SDK + Web Application (WAR) + + VaadinLibrary & Themes + + + UserSources & Themes + + + VaadinLibrary & Themes + + + User Executable& Themes + + + Apache Tomcat or any other web container + Application Server + + + Mozilla Firefox or any otherbrowser + + + Firebug Plugin (optional) + + + + + Vaadin Plugin (optional) + Deploy and Control Compile and Package + + -- cgit v1.2.3