Changed code to MVC Pattern & OOPs Principles

Author: DarshanScripts

.env

@@ -5,3 +5,4 @@ EMBEDDING_MODEL="text-embedding-3-small"
 EMBEDDING_API_VERSION="2023-05-15"
 ENDPOINT="https://ai4se-openai.openai.azure.com/"
 AZURE_OPENAI_API_KEY="VDfaCeEbTyAyPRC3C02mZyyANPxZGBxODmWOpWechSlv7GQ8zmmuJQQJ99AKACI8hq2XJ3w3AAABACOGPYeE"
+MONGODB_URI="mongodb://localhost:27017/"

.gitignore

@@ -16,4 +16,7 @@ Thumbs.db
 
 # Docker-related files
 *.log
-.env
+.env
+
+notes.txt
+temp.json

README.md

@@ -1,42 +1,63 @@
-```markdown
 # Domain Modelling Copilot
 
-Domain Modelling Copilot is an interactive web-based tool that allows users to describe scenarios in natural language and automatically generate domain models and UML diagrams using AI. It helps streamline the domain modeling process by bridging the gap between narrative and visual design.
+**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.
 
- 🛠️ Getting Started
+---
 
-1. Clone the repository
+## Features
 
-git clone https://github.com/VasiliySeibert/domain-modelling-copilot.git
-cd domain-modelling-copilot
-```
+-  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**.
 
-2. Set up a virtual environment (optional)
+---
 
-```bash
-python -m venv venv
-source venv/bin/activate  # On Windows: venv\Scripts\activate
-```
+## Tech Stack
 
-3. Install dependencies
+- **Python 3.9+**
+- **Flask** (Web Framework)
+- **OpenAI API** (Azure variant support)
+- **PlantUML** (Diagram generation)
+- **pytest** (Testing)
+- **dotenv** (Environment management)
 
-```bash
-python -m pip install -r requirements.txt
-```
+---
 
-4. Set your OpenAI API key
+## Getting Started
 
-You must have an OpenAI API key to use the application. Set it as an environment variable:
+### 1. Clone the repository
 
 ```bash
-export OPENAI_API_KEY=your_api_key_here     # On Windows: set OPENAI_API_KEY=your_api_key_here
+git clone https://github.com/YOUR_USERNAME/domain-modelling-copilot.git
+cd domain-modelling-copilot
 ```
 
-5. Run the application
-
+### 2. Create and activate a virtual environment
 ```bash
-python app.py
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+### 3. Install the dependencies
+```bash
+pip install -r requirements.txt
+```
+### 4. Configure environment variables
+Create a .env file and set your Azure OpenAI credentials:
+
+```env
+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"
 ```
 
-Visit `http://localhost:5000` in your browser.
+### 5. Run the application
+```bash
+python app.py
 ```
+Visit: http://localhost:5000

app.py

@@ -2,4 +2,5 @@ flask==2.2.5
 python-dotenv==1.0.0
 openai==1.70.0
 pytest==7.4.0
-werkzeug==2.2.3
+werkzeug==2.2.3
+pymongo==4.5.0

requirements.txt

@@ -0,0 +1,4 @@
+from src.app import app
+
+if __name__ == "__main__":
+    app.run(debug=True)