plantuml-server/README.md

45 lines
1013 B
Markdown
Raw Normal View History

PlantUML Server
===============
2013-12-11 18:17:50 +00:00
[![Build Status](https://travis-ci.org/plantuml/plantuml-server.png?branch=master)](https://travis-ci.org/plantuml/plantuml-server)
PlantUML Server is a web application to generate UML diagrams on-the-fly.
2015-03-29 18:12:21 +00:00
![](https://raw.githubusercontent.com/ftomassetti/plantuml-server/readme/screenshots/screenshot.png)
To know more about PlantUML, please visit http://plantuml.sourceforge.net/.
2015-03-29 18:12:21 +00:00
Requirements
============
2015-03-29 18:12:21 +00:00
* jre/jdk 1.6.0 or above
* apache maven 3.0.2 or above
2015-03-29 18:12:21 +00:00
How to run the server
=====================
Just run:
```
mvn jetty:run
```
The server is now listing to [http://localhost:8080/plantuml](http://localhost:8080/plantuml).
In this way the server is run on an embedded jetty server.
You can specify the port at which it runs:
```
mvn jetty:run -Djetty.port=9999"
```
How to generate the war
=======================
To build the war, just run:
2015-03-29 18:12:21 +00:00
```
mvn package
```
2015-03-29 18:12:21 +00:00
at the root directory of the project to produce plantuml.war in the target/ directory.