You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-7Lines changed: 23 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,29 @@ yarn test
51
51
It's also possible to execute and debug a single test file in VSCode/Theia via the File explorer.
52
52
Simply select a test file (`*.spec.ts`), then go to the `Run & Debug` View (`Ctrl+Shift+D`), select the 'Run current test" launch config and start debugging (`Ctrl+F11`)
53
53
54
-
## Start & Debug
54
+
## Workflow Diagram Example
55
55
56
-
### Socket
56
+
The workflow diagram is a consistent example provided by all GLSP components.
57
+
The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below).
58
+
The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone).
59
+
As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor.
60
+
See [our project website](https://www.eclipse.org/glsp/documentation/#workflowoverview) for an overview of the workflow example and all components implementing it.
To see the diagram in action, you need to choose and launch one diagram client, see [here for an overview of available clients](https://www.eclipse.org/glsp/examples/#workflowoverview).
67
+
68
+
-[`glsp-theia-integration`](https://github.com/eclipse-glsp/glsp-theia-integration): Diagrams clients integrated into [Theia](https://github.com/theia-ide/theia).
69
+
-[`glsp-vscode-integration`](https://github.com/eclipse-glsp/glsp-vscode-integration): Diagram clients integrated into [VSCode](https://github.com/microsoft/vscode).
70
+
-[`glsp-eclipse-integration`](https://github.com/eclipse-glsp/glsp-eclipse-integration): Diagram clients integrated into Eclipse IDE.
71
+
72
+
Please look at the workflow example guides in the repository linked above to get more information on building and running the respective GLSP clients.
73
+
74
+
### Launch Workflow Example Server
75
+
76
+
#### Socket
57
77
58
78
To launch the server for TCP sockets use:
59
79
@@ -67,7 +87,7 @@ To debug you can use the `Debug workflow example GLSP Server` launch configurati
67
87
To test the server you have to connect a workflow GLSP client that supports JSON-RPC via socket.
68
88
We recommend to use the client provided by the [`glsp-integration`](https://github.com/eclipse-glsp/glsp-theia-integration#how-to-start-the-workflow-diagram-example-server-from-the-sources).
69
89
70
-
### Websocket
90
+
####Websocket
71
91
72
92
To launch the server for WebSockets use:
73
93
@@ -85,7 +105,3 @@ We recommend to use the standalone example provided by [`glsp-client`](https://g
85
105
86
106
For more information, please visit the [Eclipse GLSP Umbrella repository](https://github.com/eclipse-glsp/glsp) and the [Eclipse GLSP Website](https://www.eclipse.org/glsp/).
87
107
If you have questions, please raise them in the [discussions](https://github.com/eclipse-glsp/glsp/discussions) and have a look at our [communication and support options](https://www.eclipse.org/glsp/contact/).
0 commit comments