https://github.com/robertovicario/2uml
A user-friendly tool that generates UMLs starting from natural language inputs.
https://github.com/robertovicario/2uml
flask generative-ai python uml-diagrams
Last synced: 9 months ago
JSON representation
A user-friendly tool that generates UMLs starting from natural language inputs.
- Host: GitHub
- URL: https://github.com/robertovicario/2uml
- Owner: robertovicario
- License: gpl-3.0
- Created: 2024-09-21T14:19:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-25T17:23:48.000Z (about 1 year ago)
- Last Synced: 2025-09-04T22:50:01.907Z (10 months ago)
- Topics: flask, generative-ai, python, uml-diagrams
- Language: HTML
- Homepage: https://robertovicario-2uml.hf.space
- Size: 1.58 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# 2UML
## Overview
2UML is an intuitive and efficient tool designed to streamline the process of creating Unified Modeling Language (UML) diagrams. With its user-friendly interface, 2UML empowers users to generate UML diagrams effortlessly from natural language inputs.
## Prerequisites
> [!IMPORTANT]
>
> - Docker
> - Docker Compose
## User Interface (UI)
| 
|
| :-: |
| **Home - 2UML** |
## Instructions
Usage:
```sh
bash cmd.sh {start|stop|setup|clear|build|deploy}
```
### `setup`
If you haven't built the project yet, you can do so by running:
```sh
bash cmd.sh setup
```
Once the setup process is complete, the project will be accessible at `localhost:7860`.
> [!WARNING]
>
> If this port is already in use, search for all occurrences of `7860` within the project and replace them with your preferred port number. After making these changes, you'll need to rebuild the project for the modifications to take effect.
### `start`
The program will run in debug mode, meaning frontend changes will be rendered upon reload. However, if you make changes to the backend, you will need to restart the program by running:
```sh
bash cmd.sh start
```
### `stop`
To stop the program, simply run:
```sh
bash cmd.sh stop
```
> [!TIP]
> For a quicker way to stop, use `ctrl + C` to force stop the program.
### `clear`
If you need to clear all containers and their orphaned dependencies, you can run:
```sh
bash cmd.sh clear
```
### `build`
To generate the static files for the project, run the following command:
```sh
bash cmd.sh build
```
After the build process completes, the static files will be available in the `./app/build` directory.
### `deploy`
To deploy the application to production, you can use the following command:
```sh
bash cmd.sh deploy
```
## License
This project is distributed under [GNU General Public License version 3](https://opensource.org/license/gpl-3-0). You can find the complete text of the license in the project repository.