Add sample env

Author: eddyseed

README.md

@@ -1 +1,63 @@
-API Testing Tool made with AI
+## OpenAPI Testing Tool
+
+Automatically generate comprehensive API test cases from your OpenAPI specification using a local Ollama model. This tool simplifies API validation, reduces manual effort, and integrates seamlessly into your development workflow.
+
+For learning more about OpenAPI Specifications: https://spec.openapis.org/oas/v3.1.0.html#openapi-specification
+
+### Features
+
+- **OpenAPI Integration** - Parses your API specification to understand endpoints and schemas.
+- **Local Ollama Model** - Uses a locally hosted LLM for generating intelligent test cases.
+- **Automated Test Generation** - Quickly produces unit/integration tests for endpoints.
+- **User Friendly Interface** - View the snapshots of the application below
+- **Fast & Secure** - No external API calls; all processing happens locally.
+
+### Prequisities
+
+- Node.js `v22.12.0` or higher (Important)
+- npm or yarn
+- Ollama installed locally (https://ollama.com/download)
+- Your OpenAPI specification file (`openapi.yaml` or .json)
+
+## 🛠 Installation Steps
+
+1. Clone the Repository
+
+```shell
+git clone git@github.com:eddyseed/OpenAPI-Testing-Tool.git
+cd OpenAPI-Testing-Tool/
+```
+
+2. Install Dependencies (For both Frontend & Backend)
+
+```shell
+npm install
+```
+
+3. Verify Ollama Installation
+
+```shell
+ollama list
+```
+
+Ensure your desired model (e.g., `phi3:mini`) is available.
+
+4. Edit your `.env.sample` in `backend/`
+```env
+# All variables should be changed according to the development requirements.
+
+PORT=3000
+NODE_ENV=development 
+
+LOCAL_HOST=http://localhost:3000
+CORS_ORIGIN=http://localhost:5173
+OLLAMA_HOST=http://localhost:11434
+
+#Set your own local model name
+MODEL_NAME=your_model_name
+```
+> For getting a list of all models do `ollama list`
+
+## Screenshots
+
+

backend/.env.sample

@@ -0,0 +1,13 @@
+# All variables should be changed according to the development requirements.
+
+PORT=3000
+NODE_ENV=development 
+
+LOCAL_HOST=http://localhost:3000
+CORS_ORIGIN=http://localhost:5173
+OLLAMA_HOST=http://localhost:11434
+
+#Set your own local model name
+MODEL_NAME=your_model_name
+
+#For getting a list of all models do `ollama list`

backend/package-lock.json

@@ -14,24 +14,19 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@tanstack/react-table": "^8.21.3",
-    "@xterm/xterm": "^5.5.0",
     "axios": "^1.11.0",
-    "bcryptjs": "^3.0.2",
     "chokidar": "^4.0.3",
     "cors": "^2.8.5",
     "dotenv": "^17.2.1",
     "express": "^5.1.0",
     "helmet": "^8.1.0",
     "js-yaml": "^4.1.0",
     "jsonrepair": "^3.13.0",
-    "jsonwebtoken": "^9.0.2",
     "multer": "^2.0.2",
     "socket.io": "^4.8.1",
     "tail": "^2.2.6",
     "winston": "^3.17.0",
     "ws": "^8.18.3",
-    "xterm": "^5.3.0",
     "zod": "^4.1.5"
   },
   "devDependencies": {