2UML

Overview

This project is an application that uses Natural Language Processing (NLP) to convert text inputs into UML Diagrams. It uses a Large Language Model (LLM) to interpret user requests, which are then translated into PlantUML code and rendered as diagrams.

Prerequisites

Important

• Docker
• Docker Compose

User Interface (UI)

Home - 2UML

Instructions

Usage:

bash cmd.sh {start|stop|setup|clear}

setup

If you haven't built the project yet, you can do so by running:

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:

bash cmd.sh start

stop

To stop the program, simply run:

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:

bash cmd.sh clear

License

This project is distributed under GNU General Public License version 3. You can find the complete text of the license in the project repository.