Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MontealegreLuis/phuml
phUML is a UML diagram generator. It takes arbitrary object oriented PHP code and creates fully blown class diagrams of it.
https://github.com/MontealegreLuis/phuml
graphviz php uml-class-diagram
Last synced: about 2 months ago
JSON representation
phUML is a UML diagram generator. It takes arbitrary object oriented PHP code and creates fully blown class diagrams of it.
- Host: GitHub
- URL: https://github.com/MontealegreLuis/phuml
- Owner: MontealegreLuis
- License: bsd-3-clause
- Created: 2017-12-06T01:36:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T20:16:29.000Z (about 1 year ago)
- Last Synced: 2024-07-19T12:00:45.556Z (2 months ago)
- Topics: graphviz, php, uml-class-diagram
- Language: PHP
- Homepage:
- Size: 42.3 MB
- Stars: 100
- Watchers: 7
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# phUML
[](https://github.com/montealegreluis/phuml/actions/workflows/ci.yml)
[![Scrutinizer Code Quality][scrutinizer-badge]][scrutinizer]
[![Code Coverage][coverage-badge]][coverage]
[](https://dashboard.stryker-mutator.io/reports/github.com/MontealegreLuis/phuml/master)
[![Latest Stable Version][stable-badge]][packagist]
[](https://php.net/)
phUML is a fully automatic [UML][uml] class diagram generator written in [PHP](https://php.net/).
It creates a class diagram from an Object-Oriented codebase based on the UML specification.
## Installation
## Phive
phUML can be installed by [Phive](https://phar.io/) - The PHAR Installation and Verification Environment.
```
phive install phuml
```
### Docker
The official phUML Docker image can be found on [Docker Hub](https://hub.docker.com/r/montealegreluis/phuml/).
```bash
docker pull montealegreluis/phuml
```
Here's the list of all the available Docker image [tags](https://hub.docker.com/r/montealegreluis/phuml/tags?page=1&ordering=last_updated)
## Composer
phUML can be installed globally by [Composer](https://getcomposer.org/).
```bash
composer global require phuml/phuml
```
Alternatively, you may want to install phUML as well as its dependencies.
```bash
composer require phuml/phuml
```
## How does it look like?
![UML Diagram][diagram]
The image shown here, is the class diagram generated by phUML when it's run against its [original codebase][codebase].
## Documentation
For more details visit the [documentation page][docs]
## Contribute
Please refer to [CONTRIBUTING][contribute] for information on how to contribute to phUML.
## License
Released under the [BSD-3-Clause][license].
## Credits
This code is principally developed and maintained by [Luis Montealegre][luis].
This library was created by [Jakob Westhoff][jakob].
Special thanks to all of these [awesome contributors][contributors].
[scrutinizer-badge]: https://scrutinizer-ci.com/g/MontealegreLuis/phuml/badges/quality-score.png?b=master
[scrutinizer]: https://scrutinizer-ci.com/g/MontealegreLuis/phuml/?branch=master
[uml]: http://en.wikipedia.org/wiki/Unified_Modeling_Language
[diagram]: https://raw.githubusercontent.com/MontealegreLuis/phuml/master/docs/phuml-example-thumbnail.png
[docs]: http://montealegreluis.com/phuml
[coverage-badge]: https://scrutinizer-ci.com/g/MontealegreLuis/phuml/badges/coverage.png?b=master
[coverage]: https://scrutinizer-ci.com/g/MontealegreLuis/phuml/code-structure/master/code-coverage
[composer]: https://getcomposer.org/
[codebase]: https://github.com/jakobwesthoff/phuml/tree/master/src
[stable-badge]: https://img.shields.io/packagist/v/phuml/phuml.svg?style=flat-square
[packagist]: https://packagist.org/packages/phuml/phuml
[luis]: https://github.com/MontealegreLuis
[jakob]: https://github.com/jakobwesthoff
[contributors]: https://github.com/MontealegreLuis/phuml/contributors
[contribute]: https://github.com/MontealegreLuis/phuml/blob/master/CONTRIBUTING.md
[license]: https://github.com/MontealegreLuis/phuml/blob/master/LICENSE