https://github.com/vaneeza-7/aiuml
Prompt to PlantUML chatbot
https://github.com/vaneeza-7/aiuml
Last synced: 3 months ago
JSON representation
Prompt to PlantUML chatbot
- Host: GitHub
- URL: https://github.com/vaneeza-7/aiuml
- Owner: Vaneeza-7
- License: apache-2.0
- Created: 2024-11-27T16:16:15.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-15T18:28:09.000Z (4 months ago)
- Last Synced: 2025-06-15T18:33:33.325Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 30.9 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AiUML
[](https://github.com/thelaibaasif/AiUML/actions/workflows/ci.yml)
**AiUML** is an AI-powered system designed to automate the generation of UML diagrams directly from natural language requirements. By leveraging Large Language Models, AiUML simplifies software design by providing clear, accurate UML diagrams that assist developers and engineers during system design.
## Demo Video
[](https://vimeo.com/1101900475)
---
## 🚀 Features
- **Natural Language Input**: Accepts unrestricted, ambiguous, and complex textual requirements.
- **Automated Diagram Generation**: Converts natural language input directly into UML diagrams.
- **AI-Powered Optimization**: Refines diagrams using modeling best practices and domain heuristics.
- **Diagram Customizer & Editor**: Allows real-time customization and editing in a built-in DSL editor.
- **Multi-Diagram Support**: Generates Class, Use Case, Sequence, and ERD diagrams.
- **Multiple Export Formats**: Supports exporting diagrams as SVG, PNG, and PlantUML code.
- **Session & Diagram Storage**: Saves diagrams and sessions for future access and editing.
- **User-Friendly Interface**: Web-based, minimalistic, and responsive interface.
---
## 🛠️ Tech Stack
- **Large Language Models (LLM)**: Mistral Large via Hugging Face
- **Retrieval-Augmented Generation (RAG)**: FAISS + Sentence Transformers
- **Backend**: FastAPI
- **Frontend**: React.js
- **Database**: Firebase
- **Deployment**: Render.com + Hugging Face Spaces
- **Diagram Rendering**: PlantUML
---
## Instructions
First clone repo or pull changes and then do the following:
```
cd backend
```
```
python -m venv venv
```
```
venv\Scripts\activate
```
(if you get execution policy error do this)
```
Set-ExecutionPolicy Unrestricted -Scope Process
```
(and then try activate again)
```
pip install -r requirements.txt
```
After this, To start the FastAPI server and run the model locally, do the following:
```
uvicorn main:app --reload --host 0.0.0.0 --port 8000
```
## Contributors
- [Laiba Asif](https://github.com/thelaibaasif) – Frontend Engineer
- [Rabail Nasir](https://github.com/Rabail-RN) – Backend Engineer
- [Vaneeza Ahmad](https://github.com/Vaneeza-7) – Generative AI Engineer
## License
This project is licensed under the [Apache 2.0 License](LICENSE).