{"id":20198645,"url":"https://github.com/eclipsesource/uml-glsp","last_synced_at":"2025-04-10T11:03:56.163Z","repository":{"id":43335877,"uuid":"339121640","full_name":"eclipsesource/uml-glsp","owner":"eclipsesource","description":null,"archived":false,"fork":false,"pushed_at":"2022-05-16T11:21:24.000Z","size":991,"stargazers_count":13,"open_issues_count":14,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T09:47:14.223Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipsesource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-15T15:32:23.000Z","updated_at":"2024-08-28T03:20:45.000Z","dependencies_parsed_at":"2022-09-09T07:51:08.902Z","dependency_job_id":null,"html_url":"https://github.com/eclipsesource/uml-glsp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipsesource%2Fuml-glsp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipsesource%2Fuml-glsp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipsesource%2Fuml-glsp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipsesource%2Fuml-glsp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipsesource","download_url":"https://codeload.github.com/eclipsesource/uml-glsp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248207160,"owners_count":21065194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T04:32:48.639Z","updated_at":"2025-04-10T11:03:56.130Z","avatar_url":"https://github.com/eclipsesource.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UML Editor based on GLSP\n\nUml GLSP provides a web-based editor for UML Models (including Diagrams), integrated with Eclipse Theia. It contains three components: one [Model Server](https://github.com/eclipse-emfcloud/emfcloud-modelserver) (Server-side, written in Java), one [GLSP](https://github.com/eclipse-glsp/glsp) language server (Server-side, written in Java), and one [GLSP client](https://github.com/eclipse-glsp/glsp-client) extension to actually present the diagrams (using [Sprotty](https://github.com/eclipse/sprotty-theia)). \n\nUml GLSP can display an existing UML model as a class diagram. The diagram layout will be persisted in an `.unotation` file next to the `.uml` file. The diagram editor also supports creation of new elements (Classes, Properties and Associations), as well as partial support for editing existing elements (Renaming, deleting...).\n\n![animated course class diagram](./documentation/uml-glsp-animated-classdiagram.gif)\n\n## Prerequisites\n\nThe following libraries/frameworks need to be installed on your system:\n\n| | |\n|-|-|\n|[Node.js](https://nodejs.org/en/)|`\u003e= 12.14.1`|\n|[Yarn](https://classic.yarnpkg.com/en/docs/install#debian-stable)|`\u003e=1.7.0`|\n|[Java](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)|`11`|\n|[Maven](https://maven.apache.org/)|`\u003e=3.6.0`|\n|[Git](https://git-scm.com/downloads)|`\u003e= 2.11.0`|\n\nThe editor is heavily interweaved with Eclipse Theia, so please also check the [prerequisites of Theia](https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites).\n\nThe web-based/client part of the editor has been developed using [Visual Studio Code](https://code.visualstudio.com/) and the server/java part has been developed with the [Eclipse IDE](https://www.eclipse.org/ide/).\nSettings for codestyle are provided for both IDEs, however, it's of course also possible to use any other IDE or text editor.\n\n## Getting started\n\nClone the uml-glsp editor:\n\n    git clone https://github.com/eclipsesource/uml-glsp.git\n\n### Build\n\nThe server components have to be built using Maven, the client component has to be built using yarn. This can be done via CLI:\n\n    cd server \u0026\u0026 mvn clean install \u0026\u0026 cd ..\n    cd client \u0026\u0026 yarn \u0026\u0026 cd ..\n\n#### Resolving build issues under Windows/MacOS\n\n- Missing build tools result in following error:\n\n      gyp err! stack error: could not find any visual studio installation to use\n\n  - Windows:\n    - Install via `npm install --global --vs2015 windows-build-tools`\n    - Check that `npm config get msvs_version` returns `2015`\n  - Mac OS:\n    - Install [Xcode](https://developer.apple.com/xcode/) developer tools\n\n### Run\n\n    cd client \u0026\u0026 yarn start\n\nStart your browser on [http://localhost:3000](http://localhost:3000).\n\n#### Open diagrams (`*.uml`)\n\n- Add/Delete/Rename support for the following UML Elements: `Class`, `Property`, `Association`\n\n#### Create new diagrams\n\n- via menu entry `File -\u003e New UML Class Diagram`\n- via explorer context menu entry `New UML Class Diagram`\n- via command palette `File: New UML Class Diagram`\n\nFor detailed information on running and debugging the [server](./server/README.md) and [client](./client/README.md) components, please see their respective READMEs.\n\n## More information\n\nFor more information, please visit the [EMF.cloud Website](https://www.eclipse.org/emfcloud/). If you have questions, contact us on our [spectrum chat](https://spectrum.chat/emfcloud/) and have a look at our [communication and support options](https://www.eclipse.org/emfcloud/contact/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipsesource%2Fuml-glsp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipsesource%2Fuml-glsp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipsesource%2Fuml-glsp/lists"}