Eclipse GLSP - Client

A web-based diagram client framework for the Graphical Language Server Platform (GLSP) based on Eclipse Sprotty.

Structure

• @eclipse-glsp/protocol: Generic client-server communication protocol
• @eclipse-glsp/client: sprotty-based GLSP client

Building

This project is built with yarn and is available from npm via @eclipse-glsp/protocol and @eclipse-glsp/client.

Workflow Diagram Example

The workflow diagram is a consistent example provided by all GLSP components. The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below). The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone). As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor. See our project website for an overview of the workflow example and all components implementing it.

How to start the Workflow Diagram example?

Clone this repository and build the glsp-client packages:

yarn install

Next, download a pre-built version of the Workflow Example Diagram Server and start it (replace X.X.X with the current version, the download script will print out the correct command on the console):

yarn download:exampleServer
java -jar org.eclipse.glsp.example.workflow-X.X.X-SNAPSHOT-glsp.jar org.eclipse.glsp.example.workflow.launch.ExampleServerLauncher --port=8081 --websocket

Once the server is running, open the glsp-client/examples/workflow-standalone/app/diagram.html file in your favorite browser.

How to start the Workflow Diagram example server from the sources

If you want to explore or change the Workflow Diagram Server too, you can clone, build and start the workflow example glsp-server from your IDE instead of using the pre-built version of the Workflow Diagram Server. See workflow example glsp-server for instructions on building and running the Workflow Diagram Server example.

Where to find the sources?

In addition to this repository, the source code of the Workflow Diagram server example can be found here: https://github.com/eclipse-glsp/glsp-server/tree/master/examples/org.eclipse.glsp.example.workflow

More information

For more information, please visit the Eclipse GLSP Umbrella repository and the Eclipse GLSP Website. If you have questions, please raise them in the discussions and have a look at our communication and support options.