hakenadu / plantuml-editor Goto Github PK

The Dockerfile has to be adapted so that the application is run as non-root user.

Please add feature for configure sub-folder location to host.
Example: localhost/my/path/to/uml.

Implement ChatGPT API for generating PlantUML diagrams by textual descriptions.

Support redis for creating shared links next to webdav.

Currently the maximum image size depends on the browser window size.

For large diagrams it may be useful to remove the boundaries of the image tag containing the plantuml image.

Create a simple and en extended example for PlantUML class diagrams:

https://plantuml.com/de/class-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

I want to have the possibility to have an url, probably a subpath, which only allows to display the graphic and the (configurable) the source of the diagram, without the possibility to create a diagram on its own. So I can share a link without revealing the editor and giving access to anyone.

If it would be a subpath one could easily be protected by Nginx, etc.

Create a simple and en extended example for PlantUML object diagrams:

https://plantuml.com/de/object-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

When docker-image started without access to WEB (on intranet network) some icons, stylesheets, etc don`t working.

May be place static resources locally in project and docker-image?

Create a simple and en extended example for PlantUML deployment diagrams:

https://plantuml.com/de/deployment-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

Customizing of "description.component.html" in docker-image is very difficult without building project.

May be placed this resource in custom folder and mount this folder on docker-volumes?

graphviz has to be installed while building the docker image

Create a simple and en extended example for PlantUML activity diagrams:

https://plantuml.com/de/activity-diagram-beta

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

Create a simple and en extended example for PlantUML state diagrams:

https://plantuml.com/de/state-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

The current autocomplete functionality is just based on a static set of terms and doesn't take the diagram context into account.

See https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/editor/editor.component.ts#L111

Create a simple and en extended example for PlantUML timing diagrams:

https://plantuml.com/de/timing-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13

It can be extremely useful to share the current state of a diagram using an URI.

Those may look like:

• https://${host}/diagrams/${base64-encrypted-resource-url}
• https://${host}/diagrams?url=${diagram-url}

The user should configure the diagram persistence location as he surely doesn't want to have his diagrams persisted at the server where the application is deployed (except for a scenario where the app ist hosted in the users infrastructure).

The following shows an example for how this could work using a custom webdav:

@startuml

actor User
participant PlantumlEditorFrontend
participant CustomWebdav

activate User
User -> PlantumlEditorFrontend: click 'generate permalink'

activate PlantumlEditorFrontend
PlantumlEditorFrontend --> User: persistence configuration modal
deactivate PlantumlEditorFrontend

User -> PlantumlEditorFrontend: configure persistence with type 'webdav' for custom webdav installation
activate PlantumlEditorFrontend
PlantumlEditorFrontend -> PlantumlEditorFrontend: store configuration in local storage
PlantumlEditorFrontend -> CustomWebdav: PUT diagram spec

activate CustomWebdav
CustomWebdav -> CustomWebdav: store diagram spec
CustomWebdav --> PlantumlEditorFrontend: 200
deactivate CustomWebdav

PlantumlEditorFrontend --> User: success modal and copied url to clipboard
deactivate PlantumlEditorFrontend

deactivate User

@enduml

Create a simple and en extended example for PlantUML component diagrams:

https://plantuml.com/de/component-diagram

• Create a folder below https://github.com/Hakenadu/plantuml-editor/tree/master/plantuml-editor-frontend/src/assets/example-diagrams
• Create a simple.pu with a simple example PlantUML spec
• Create an extended.pu with an extended example PlantUML spec
• Register the diagram in https://github.com/Hakenadu/plantuml-editor/blob/master/plantuml-editor-frontend/src/app/description/description.component.ts#L13