Installation

Running standalone Client

To run Graphity Client:

• build the Client from source as a Maven Web application
• run the webapp in an IDE or deploy the .war on a servlet container such as Tomcat
• open the webapp in a browser (on an address such as http://localhost:8080/graphity-client; it depends on host, Tomcat port and application context path)

Using Client in your application

To add Graphity Client dependency:

• for a stable version

  • find the latest one on Maven

• for a SNAPSHOT version

  • build the Client from source

• add Graphity Client as a Maven dependency in your project using an IDE, or in the pom.xml file. <classifier>classes</classifier> addresses the jar artifact built into war. The <type>war</type> dependency enables reuse of static resources from Graphity Client, such as Twitter Bootstrap

    <dependencies>
        <dependency>
            <groupId>org.graphity</groupId>
            <artifactId>client</artifactId>
            <version>1.1.3</version>
            <classifier>classes</classifier>
        </dependency>
        <dependency>
            <groupId>org.graphity</groupId>
            <artifactId>client</artifactId>
            <version>1.1.3</version>
            <type>war</type>
        </dependency>
    </dependencies>
  

• to import static resources enabled by the <type>war</type> dependency, add a Maven overlay under <configuration> of maven-war-plugin:

    <overlays>
        <overlay>
            <groupId>org.graphity</groupId>
            <artifactId>client</artifactId>
        </overlay>
    </overlays>
  

• add or edit main/webapp/WEB-INF/web.xml with Configuration

Building from source

• install Graphity Core dependency
• checkout the source code
• build it as jar using Maven (dependency Maven profile: mvn -Pdependency package)
• build it as war using Maven (standalone Maven profile: mvn -Pstandalone package)

Deployment

When you produce a WAR file of Graphity application, it needs to be deployed on a servlet container. We run and test on Tomcat 7, but Tomcat 8 and others such as Glassfish or Jetty should also work. You might need to configure Tomcat options, for example:

-XX:MaxPermSize=256m -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true