Eclipse GLSP Examples

This repository contains code examples that demonstrate how to build diagram editors with the Graphical Language Server Platform (GLSP). The examples are focused on the integration of GLSP editors with the cloud-based Eclipse Theia IDE using the GLSP Theia integration.

Each example is self-contained and provides both, an example diagram client and its corresponding GLSP server.

Prerequisites

The following libraries/frameworks need to be installed on your system:

• Node.js >= 12.14.1 AND < 13
• Yarn >=1.7.0
• Java >=11
• Maven >=3.6.0

The examples are heavily interweaved with Eclipse Theia, so please also check the prerequisites of Theia.

The web-based/client part of the examples has been developed using Visual Studio Code and the server/java part has been developed with the Eclipse IDE. However, it's of course also possible to use any other IDE or text editor.

Building the minimal example

The server component of the minimal example has to be built using Maven, the client component has to be built using yarn. This can be done via CLI:

git clone https://github.com/eclipse-glsp/glsp-examples.git
cd minimal
cd server/org.eclipse.glsp.example.minimal && mvn clean install && cd ../..
cd client && yarn && cd ..

Running the minimal example

To start the Theia web app with the integrated minimal example simply navigate to the client directory :

cd minimal/client 

and then execute:

yarn start:browser

This will launch the example in the browser on localhost:3000.

Examples

• Minimal Example: A very simple GLSP editor for rectangular nodes. This demonstrates the core concepts and basic client-server integration into Theia.

More information

For more information, please visit the Eclipse GLSP Umbrella repository and the Eclipse GLSP Website. If you have questions, contact us on our spectrum chat and have a look at our communication and support options.