UI: Markdown formation of responses in chatbox

& added test cases

Author: DarshanScripts

.gitignore

@@ -4,6 +4,7 @@ __pycache__/
 *.pyo
 *.pyd
 *.ipynb_checkpoints/
+.pytest_cache/
 
 # IDE-specific files
 .vscode/

README.md

@@ -1,2 +1,42 @@
-# domain-modelling-copilot
- 
+```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.
+
+ 🛠️ Getting Started
+
+1. Clone the repository
+
+git clone https://github.com/VasiliySeibert/domain-modelling-copilot.git
+cd domain-modelling-copilot
+```
+
+2. Set up a virtual environment (optional)
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+3. Install dependencies
+
+```bash
+python -m pip install -r requirements.txt
+```
+
+4. Set your OpenAI API key
+
+You must have an OpenAI API key to use the application. Set it as an environment variable:
+
+```bash
+export OPENAI_API_KEY=your_api_key_here     # On Windows: set OPENAI_API_KEY=your_api_key_here
+```
+
+5. Run the application
+
+```bash
+python app.py
+```
+
+Visit `http://localhost:5000` in your browser.
+```