Max P. b7589ffa65 Adds MIT license to the repository
Introduces the MIT license to define usage, distribution, and liability terms for the project.

Provides clarity on software permissions and legal disclaimers.
2025-04-22 21:02:52 +00:00
2025-04-22 21:02:52 +00:00

PlantUML Devcontainer Template

Dieses Template stellt eine vollständig vorbereitete Entwicklungsumgebung für die Arbeit mit PlantUML bereit – inklusive Server-Modus direkt im Container. Es eignet sich sowohl für lokale Entwicklung mit Visual Studio Code als auch für reproduzierbare Team- oder CI-Setups.

Features

  • 🐳 Devcontainer-kompatibel (VSCode Remote Containers / Codespaces)
  • Java + Graphviz vorinstalliert
  • 🌐 PlantUML-Server wird beim Start automatisch aktiviert (localhost:8080)
  • 🧠 Kein externer Docker nötig, keine separate Java-Installation
  • 🔁 Wiederverwendbar, reproduzierbar, offlinefähig

🚀 Loslegen

  1. Repository clonen:

    git clone https://github.com/deinuser/plantuml-devcontainer-template.git
    cd plantuml-devcontainer-template
    
  2. In VSCode öffnen:

    code .
    
  3. Devcontainer starten (automatisch über VSCode gefragt oder über Befehls-Palette: Dev Containers: Reopen in Container)

  4. .puml-Datei erstellen oder öffnen und Alt+D drücken für die Vorschau.

⚙️ Technische Details

  • Der PlantUML-HTTP-Server wird beim Öffnen eines Terminals automatisch gestartet, wenn er noch nicht läuft.
  • Das geschieht über ein kleines Shellskript (~/.start-plantuml.sh), das in .bashrc eingebunden ist.
  • Serveradresse für die VSCode-Erweiterung ist vordefiniert: http://localhost:8080

📂 Struktur

.devcontainer/
├── devcontainer.json
├── Dockerfile
README.md
uml/
└── beispiel.puml

🧪 Beispiel

@startuml
Alice -> Bob: Hello
@enduml

📄 Lizenz

MIT – Verwenden, anpassen, verbessern.

Description
🚀 PlantUML Devcontainer mit integriertem Server und automatischem Start – für reproduzierbare, VSCode-kompatible UML-Workflows.
Readme MIT 31 KiB
Languages
Dockerfile 100%