Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RafaelKuebler/PlantUMLDesignPatterns
https://github.com/RafaelKuebler/PlantUMLDesignPatterns
design-patterns plantuml
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/RafaelKuebler/PlantUMLDesignPatterns
- Owner: RafaelKuebler
- License: mit
- Created: 2019-03-24T11:26:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T11:30:00.000Z (over 4 years ago)
- Last Synced: 2024-08-02T16:46:19.640Z (3 months ago)
- Topics: design-patterns, plantuml
- Language: Python
- Size: 16.6 KB
- Stars: 53
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Plant UML Design Patterns
[PlantUML](http://plantuml.com/index) code for some Design Patterns.
The syntax can be looked up on [PlantUML's class diagram documentation](http://plantuml.com/class-diagram).
## Example
Code | Diagram
--- | ---
| 
## Included patterns
| Creational | Structural | Behavioral |
| ---------------- | ---------- | ----------------------- |
| Abstract factory | Adapter | Chain of Responsibility |
| Builder | Bridge | Command |
| Factory method | Composite | Interpreter |
| Prototype | Decorator | Iterator |
| Singleton | Facade | Mediator |
| | Flyweight | Memento |
| | Proxy | Observer |
| | | State |
| | | Strategy |
| | | Template method |
| | | Visitor |
## Running
If you do not intend to run locally, please have a look at the alternatives found in [this overview](http://plantuml.com/running).
### Prerequisites
To run locally, the PlantUML jar (from [PlantUML's download site](http://plantuml.com/download)) is needed.
As described on the [Getting started](http://plantuml.com/starting) site, you will also need both [Java](https://www.java.com/en/download/) and [Graphviz](https://www.graphviz.org/) installed on your machine.
### Creating the diagrams
The easiest way is to just run the included python script ([run.py](run.py)).
It checks for changes in the diagram files and only generates the new/changed ones.
The PlantUML jar should be in the same directory.
```
python run.py
```
The generated diagrams are stored in the *output* folder.
To run PlantUML directly from the command line for one specific diagram, you can execute:
```
java -jar plantuml.jar diagram.txt
```
## Built With
* [PlantUML](http://plantuml.com/)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
* The pattern descriptions and overall class diagram arrangements are taken from a cheat sheet from [Jason Mcdonalds blog](http://www.mcdonaldland.info/2007/11/28/40/)