alexitc/collabuml

A collaborative UML editor; build with etherpad and plantuml

Getting started

CollabUML is a PlantUML based app for online collaborative design on UML

How it works?

CollabUML is a super-simple client only app that wires existing technology, in this case, it uses an https://etherpad.org to handle the collaborative text editor and https://plantuml.com/ public server to render the editor's content.

There is a timer that takes the etherpad content to render it with plantuml on every tick.

Run it

An Etherpad instance is required, host/apikey must be configured at config.js

Then, run npm install to download the js dependencies, then, npm run start will allow you to use the app at localhost:8080

Project state

The project was created in 2020, there haven't been much changes since then, I plan to keep the server running for as long as it doesn't require much maintenance (the case for 3 years).

collabuml's Issues

Render Image not showing on demo site

Hi, Very keen on this idea, when testing it out on your hosted site I started a new page: https://pad.collabuml.com/p/1AL_Moz7UjiKd1UCsaNv
and cleared all to a text sample from plantuml:

@startuml
folder folder [
This is a <b>folder
----
You can use separator
====
of different kind
....
and style
]
@enduml

I waited, expecting the diagram to render, it didn't.
Was it supposed to?