ExplorViz Backend (based on new architecture)
Clone or download

README.MD

ExplorViz Backend

TravsCI Build Status Jenkins Build Status Sonarcloud Status Dockerhub Pulls

This project contains the modernized version of ExplorViz.

It substitutes GWT and it's (asynchronous) RPC framework with Jersey for creating a RESTful API. This is only the backend, you will need the explorviz-frontend as well.

This gradle project includes or installs every necessary dependency.

Documentation (Work in progress)

The API documentation is available here.

Eclipse Setup

  1. Download the latest Eclipse IDE for Java Developers and Oracle Java SDK 8
  2. Install SpotBugs (formerly known as Findbugs)
    • Start Eclipse -> Help -> Eclipse Marketplace* - type in Spotbugs and install SpotBugs Eclipse plugin 3.1.5
  3. Install PMD and Checkstyle embedded in qa-eclipse-plugin
  4. Show the respective tool views (Window -> Show View -> Other - check Bug Explorer, Checkstyle Violations, and PMD Violations)

Setup Development

  1. Follow the Eclipse Setup
  2. Clone this repository
  3. Import project into eclipse: via Import -> Gradle -> Existing Gradle project -> path/to/explorviz-backend
  4. Start explorviz-backend via Eclipse Tab: Gradle Tasks -> explorviz-backend -> gretty -> appStart
  5. Setup and start explorviz-frontend

Further Information

  • To force the download of newly added dependencies: Right click on the project explorviz-backend -> Gradle -> Refresh Gradle Project. You might need to uncomment the respective lines in the build.gradle file.
  • Generating API Documentation: Travis CI automatically builds all Javadoc on successful master-branch builds

Quick start with sample (dummy) monitoring

  1. Follow the above Setup Development procedure
  2. Clone TestApplication
  3. Start the TestApplication as described here.
  4. Open explorviz-frontend

Important: Changes that are related to dependency injections require a recompilation of the application. Use the gradle task explorviz-backend -> gretty -> appRestart to recompile and start the server. Then, start the monitoring again.