https://github.com/alexitc/collabuml
A collaborative UML editor; build with etherpad and plantuml
https://github.com/alexitc/collabuml
collaborative-editing etherpad plantuml uml
Last synced: 8 months ago
JSON representation
A collaborative UML editor; build with etherpad and plantuml
- Host: GitHub
- URL: https://github.com/alexitc/collabuml
- Owner: AlexITC
- License: mit
- Created: 2023-01-28T04:34:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T15:45:18.000Z (about 2 years ago)
- Last Synced: 2025-04-07T08:28:51.691Z (about 1 year ago)
- Topics: collaborative-editing, etherpad, plantuml, uml
- Language: JavaScript
- Homepage: https://collabuml.com
- Size: 126 KB
- Stars: 170
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](./src/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).