2uml

A user-friendly tool that generates UMLs starting from natural language inputs.

https://github.com/robertovicario/2uml

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary

Keywords

fastapi generative-ai huggingface python
Last synced: 6 months ago · JSON representation

Repository

A user-friendly tool that generates UMLs starting from natural language inputs.

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 4
  • Releases: 0
Topics
fastapi generative-ai huggingface python
Created over 1 year ago · Last pushed 9 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

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)

| 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. You can find the complete text of the license in the project repository.

Owner

  • Name: Roberto Vicario
  • Login: robertovicario
  • Kind: user
  • Location: Como, Italy
  • Company: University of Insubria

Software Engineer

GitHub Events

Total
  • Issues event: 5
  • Watch event: 4
  • Delete event: 3
  • Push event: 28
  • Create event: 6
Last Year
  • Issues event: 5
  • Watch event: 4
  • Delete event: 3
  • Push event: 28
  • Create event: 6

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • robertovicario (6)
Pull Request Authors
Top Labels
Issue Labels
enhancement (4) discovery (1)
Pull Request Labels

Dependencies

app/Dockerfile docker
  • python 3.9 build
docker-compose.yml docker
  • mongo 6.0
app/requirements.txt pypi
  • fastapi *
  • huggingface_hub *
  • uvicorn *