https://github.com/ericsson/plantuml-interactive-editor
A graphical editor for PlantUML diagrams
https://github.com/ericsson/plantuml-interactive-editor
Last synced: 8 months ago
JSON representation
A graphical editor for PlantUML diagrams
- Host: GitHub
- URL: https://github.com/ericsson/plantuml-interactive-editor
- Owner: Ericsson
- License: mit
- Created: 2024-09-24T09:10:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-06T14:00:58.000Z (8 months ago)
- Last Synced: 2025-05-07T18:15:52.527Z (8 months ago)
- Language: Python
- Size: 855 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# PlantUML Interactive Editor
Welcome to PlantUML Interactive Editor! This application is designed to provide an intuitive and interactive environment for editing PlantUML code and generating diagrams in real-time. Whether you're creating a huge activity diagram or a single while loop, our tool streamlines the process, allowing you to focus on design rather than syntax.
With PlantUML Interactive Editor, you can:
- Edit PlantUML activity diagrams by directly interacting with the diagram
- Also change the diagram by editing the PlantUML code, just like other PlantUML editors, allowing you to choose code or interactive editing depending on what is easier in the moment
- Instantly preview diagrams as you type
- Easily share the created diagram
## Usage
- Right-click on elements to open context menu
- Double-click on elements to edit the text
- Submit edited text with the button or using CTRL + ENTER
- Left-click and drag in the diagram to pan
- Use mouse wheel or pinch on touch pad to zoom
- Delete the text of a title, note or group/partition to delete the element
- To share a diagram, just copy the URL in the address bar
- Hover over elements to see the corresponding line highlighted in the editor
- Clicking on a line with an activity in the editor highlights the corresponding activity in the diagram
## Detailed list of supported and unsupported features
[FEATURES.md](./FEATURES.md)
## Pre-requisites
- Python 3.10 or newer
- PlantUML, https://plantuml.com/starting
- The path to the PlantUML must be set in an .env file, see .env.example
## Installing and running the server
In the target python environment:
```
pip install .
python -m plantuml_gui
```
## Development
### Pre-requisites
- uv
### Setup
```
uv run pre-commit install -t pre-commit -t pre-push
```
### Running tests
#### Python
##### Without coverage
```
uv run pytest
```
##### With coverage
```
uv run python -m pytest --cov --cov-report=html
```
#### Javascript
1. Run `uv run python -m http.server` and open the server in a browser
2. In the browser, open tests/js/SpecRunner.html