umple/umpleonline repository overview

Umple is a tool for what we call model-oriented programming. It allows you to a) embed UML class diagram concepts (e.g. associations) and state machines into languages like Java; b) generate high quality code from UML; c) generate diagrams, metrics and other products from your software.

UmpleOnline is a web interface for Umple, designed for experimentation with Umple and learning about modeling. You can edit Umple code (including a textual form of UML) and embedded Java code. Generated diagrams appear as you edit the code. You can also edit class diagrams and see the textual Umple code instantly update.

This repository allows anyone to run UmpleOnline locally on their own computer, instead of using the website http://try.umple.org⁠.

To use:

1. Install Docker for your platform e.g. from https://www.docker.com/community-edition⁠

2. Run the docker server on your system (some people have reported that the following doesn't work because docker has to be actually running, not just installed)

3. To be able to save your data, create a directory on your computer to store your model. We will call it /Users/myuserid/umodel - but change the following to match your directory

4. Pull the latest: docker pull umple/umpleonline This is updated regularly and will be the same as the version present on UmpleOnline

5. Run the command: docker run --rm -ti -p 8000:8000 -v /Users/myuserid/umodel:/var/www/ump umple/umpleonline >/dev/null

(in the above, the first 8000 can be changed to a port you would prefer to use on your machine, and you would change this in point 6 below too)

1. Point your web browser at http://localhost:8000/umple.php?model=umodel⁠ .

There is a script called udock in the dev-tools directory of the Umple Github repository https://github.com/umple/umple/blob/master/dev-tools/udock⁠ that can automate the above process.

More details can be found at http://dl.umple.org⁠ .

A new image is currently created for every official release of Umple. Interim images may also be created between official releases. These can be found at https://hub.docker.com/r/umple/umpleonline/tags/⁠

Umple is released as open source under the MIT license http://license.umple.org⁠ . Code is available at https://github.com/umple/umple⁠ . For larger-scale use of Umple, and separately from this Docker image, you can also integrate Umple into your command-line or Eclipse workflow at http://dl.umple.org⁠

Umple is targeted particularly to small companies, to open source developers, and for use in teaching software engineering in schools and universities. Umple is written in itself using model-driven development and test-driven development. The lead institution is the University of Ottawa, although there have been over 60 contributors from universities throughout Canada and elsewhere (mostly PhD, Masters and 4th year students).

For more information about Umple, visit https://www.umple.org⁠