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: about 5 hours 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 (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-28T16:45:26.000Z (almost 2 years ago)
• Last Synced: 2023-11-07T18:54:42.258Z (about 1 year ago)
• Topics: collaborative-editing, etherpad, plantuml, uml
• Language: JavaScript
• Homepage: https://collabuml.com
• Size: 126 KB
• Stars: 168
• Watchers: 2
• Forks: 3
• Open Issues: 1
• 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).