https://github.com/bluegob/uml-generator
A simple web app to generate uml diagrams with some input fields and checkboxes
https://github.com/bluegob/uml-generator
Last synced: 10 months ago
JSON representation
A simple web app to generate uml diagrams with some input fields and checkboxes
- Host: GitHub
- URL: https://github.com/bluegob/uml-generator
- Owner: BlueGob
- License: gpl-3.0
- Created: 2023-09-22T19:08:12.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-24T07:47:19.000Z (almost 3 years ago)
- Last Synced: 2024-11-13T17:35:58.852Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 3.38 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPLv3 License][license-shield]][license-url]
UML Generator
A simple web app to generate uml diagrams with some input fields and checkboxes
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
## About The Project
This project is a tool for generating PlantUML code to create diagrams from user-provided input fields and selected checkboxes.
It simplifies the process of creating diagrams by allowing users to define elements and relationships through a user-friendly interface.
### Built With
## Getting Started
### Prerequisites
Python 3.10 installed on your system.
plantUml server running on your machine. check this [link](https://github.com/plantuml/plantuml-server) to install plantuml server locally
### Installation
1. Clone the repo
```sh
git https://github.com/BlueGob/uml-generator.git
```
2. Create venv
```sh
cd uml-generator
python3 -m venv .venv
```
3. Install requirements
```sh
pip install -r requirements.txt
pip install streamlit-tree-select-0.0.5/
```
4. run
```
streamlit run main.py
```
## Roadmap
- [x] use case diagrams
- [ ] class diagram
- [ ] sequence diagram
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GPL 3.0 License. See `LICENSE.txt` for more information.
## Acknowledgments
* [Othneildrew](https://github.com/othneildrew/Best-README-Template)
* [Schluca](https://github.com/Schluca/streamlit_tree_select)
[contributors-shield]: https://img.shields.io/github/contributors/BlueGob/uml-generator.svg?style=for-the-badge
[contributors-url]: https://github.com/BlueGob/uml-generator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/BlueGob/uml-generator.svg?style=for-the-badge
[forks-url]: https://github.com/BlueGob/uml-generator/network/members
[stars-shield]: https://img.shields.io/github/stars/BlueGob/uml-generator.svg?style=for-the-badge
[stars-url]: https://github.com/BlueGob/uml-generator/stargazers
[issues-shield]: https://img.shields.io/github/issues/BlueGob/uml-generator.svg?style=for-the-badge
[issues-url]: https://github.com/BlueGob/uml-generator/issues
[license-shield]: https://img.shields.io/github/license/BlueGob/uml-generator.svg?style=for-the-badge
[license-url]:https://github.com/BlueGob/uml-generator/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png