teavm/README.md

TeaVM

What is TeaVM?

TeaVM is an ahead-of-time translator from Java bytecode to JVM. It can be compared with GWT, however TeaVM does not require source code of your application and all required libraries. You can use TeaVM for building applications for the browser, due to the following features:

• per-method dependency analyzer, that determines a set of methods that are really needed to run your application, so TeaVM won't translate whole JAR files;
• fast JavaScript; for now it is almost as fast as the JavaScript, generated by GWT;
• Java class library emulation;
• integration with Maven and Eclipse;
• generation of source maps;
• debugger;
• interoperation with JavaScript libraries together with the set of predefined browser interfaces.

How to use

There are several options of using TeaVM. One is the Maven build. First, you write your code as if it were an ordinary Java application:

package org.teavm.samples;

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, world!");
    }
}

Second, you include the following plugin in your pom.xml build section:

    <plugin>
      <groupId>org.teavm</groupId>
      <artifactId>teavm-maven-plugin</artifactId>
      <version>0.2</version>
      <dependencies>
        <dependency>
          <groupId>org.teavm</groupId>
          <artifactId>teavm-classlib</artifactId>
          <version>0.2</version>
        </dependency>
      </dependencies>
      <executions>
        <execution>
          <id>generate-javascript</id>
          <goals>
            <goal>build-javascript</goal>
          </goals>
          <phase>process-classes</phase>
          <configuration>
            <minifying>true</minifying>
            <mainClass>org.teavm.samples.HelloWorld</mainClass>
            <mainPageIncluded>true</mainPageIncluded>
          </configuration>
        </execution>
      </executions>
    </plugin>

Now you can execute mvn clean package and get the generated JavaScript files in target/javascript folder. Just open target/javascript/main.html page in your browser, open developer's console and press Refresh and see what happen.

There is also the teavm-samples module, containing examples of TeaVM-based projects.

DukeScript

DukeScript is a set of APIs that allows Java applications easily talk to JavaScript environment to (usually) animate an HTML page. While DukeScript has its own implementation of JVM, called Bck2Brwsr, TeaVM also provides support for running DukeScript applications, using teavm-html4j plugin.

Live examples

Thanks to Jaroslav Tulach, author of DukeScript, we have several DukeScript example applications. One is the minesweeper game. You can try its TeaVM-compiled version here, and then take a look at source code and HTML page.

Another example is avaialble here. It uses GraphHopper to build route in browser. Unlike original GraphHopper example it works completely in browser instead of querying server. Thanks to Peter Karich.