domain-modelling-copilot

Domain Modelling Copilot

Domain Modelling Copilot is a web-based assistant that transforms natural language scenarios into domain models and generates UML diagrams automatically. Powered by OpenAI, it streamlines the process of moving from user stories to structured models.

---

Features

• Accepts user scenarios in natural language.
• Classifies input as “General” or “Scenario” intelligently.
• Generates detailed scenarios and concise summaries using GPT models.
• Converts extracted domain structures into PlantUML diagrams.
• Includes a full test suite for backend routes with pytest.

---

Tech Stack

• Python 3.9+
• Flask (Web Framework)
• OpenAI API (Azure variant support)
• PlantUML (Diagram generation)
• pytest (Testing)
• dotenv (Environment management)

---

Getting Started

1. Clone the repository

git clone https://github.com/YOUR_USERNAME/domain-modelling-copilot.git
cd domain-modelling-copilot

2. Create and activate a virtual environment

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install the dependencies

pip install -r requirements.txt

4. Configure environment variables

Create a .env file and set your Azure OpenAI credentials:

API_TYPE="azure"
GPT_MODEL="gpt-4o-mini"
GPT_API_VERSION="2024-08-01-preview"
EMBEDDING_MODEL="text-embedding-3-small"
EMBEDDING_API_VERSION="2023-05-15"
ENDPOINT="https://your-azure-endpoint/"
AZURE_OPENAI_API_KEY="your-api-key"

5. Run the application

python app.py

Visit: http://localhost:5000