ExplorViz Frontend (based on new architecture)
Clone or download
Latest commit cc7cd4a Oct 18, 2018

README.md

ExplorViz Frontend

Build Status Build status Dependency Status devDependencies status Greenkeeper badge

This project is a WIP replica of ExplorViz's visualization component. It substitutes GWT client-code with EmberJS. This is only the frontend, you will need the backend as well for production. However, you can mock the backend as shown in the development section below.

Documentation (Work in progress)

The API documentation is available here.

Deployment

There are two options for you at the moment. Browse to our docker repository.

  • Clone the repository and deploy the built artifacts "explorviz-backend.war" and "explorviz-frontend" in a Tomcat
  • OR Use Docker as shown in the respective README.md

Development

Prerequisites

You will need the following things properly installed on your computer.

Installation (Generic)

  • git clone <repository-url> this repository
  • cd explorviz-frontend
  • npm install -g ember-cli
  • npm install -g yuidocjs
  • npm install

Running / Development

Mocking the Backend

You can mock the backend, for example if you don't need live data for your development (or as showcase). Therefore, you are not required to download and run the ExplorViz Backen Java project. To achieve this, run the frontend with ENABLE_MOCK=true ember s --environment=mocked.

Testing

  • npm test or ember test / ember test --server

Building

  • npm build or ember build (development) / ember build --environment production (production)

Generating API Documentation

  • yuidoc . (Might need to delete content of tmp folder. Be aware! The result of this command should be commited at the end of your development, since it generates a lot of LoC.)