Skip to main content
Version: Next

Overview

The Evolve App allows users to visualise, search, and perform analysis on an energy distribution network in a browser. The Evolve App Server handles all requests from the Evolve Web Client - providing the client with authentication and configuration information, as well as persisting user preferences and session state. The Evolve App Server also acts as a gateway between the Evolve Web Client and the Energy Workbench Server, making sure the user is authenticated before passing through requests for map tiles or network data to EWB.

This document describes how to configure and run the Evolve App Server.

Build​

To build and package, run:

mvn clean package

Configuration​

Configuration for the Evolve App Server is specified in a JSON file. The server requires a configuration file to start.

For details on how to write a configuration file, refer to Configuration.

Run​

To start the server using the resulting jar, run:

java -jar evolve-app-server.jar -c path/to/config.json

Test​

To run tests, run:

mvn clean test

API​

When the server is running, it exposes an API than can be used by a client to find information about the app, or pass through requests to EWB.

For thorough API documentation, refer to API.