Merge remote-tracking branch 'origin/master'

readme.md

@@ -0,0 +1,46 @@
+# Mock API Manager
+
+Welcome to my hobby project - the Mock API Manager! This TypeScript-based tool simplifies the creation and management of mock APIs for your development and testing needs.
+
+<img width="1440" alt="Screenshot 2023-09-16 at 11 13 59 PM" src="https://github.com/chtgupta/mock_api_backend/assets/22120812/8a5cbab6-bb82-48d5-b1dc-4037367fac94">
+
+## Features
+
+- Create and manage mock API endpoints with custom responses.
+- Get a permanent URL for mock responses.
+- Real-time updates for quick testing.
+
+## Tech Stack
+
+- TypeScript
+- MongoDB
+- NodeJS - Express - Mongoose
+
+## Getting Started
+
+1. **Clone the Repository:** 
+   ```
+   git clone https://github.com/chtgupta/mock_api_backend.git
+   ```
+
+2. **Add .env file:**
+   ```
+   PORT = YOUR PORT
+   DB_URL = YOUR DB
+   ```
+
+4. **Run the Application:**
+   ```
+   tsc && node ./dist/index.js
+   ```
+
+3. **Web Interface:** Not public yet, just use Postman for now.
+
+## Usage
+
+Use Postman to make see and make requests
+
+[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/27705573-59f1e97e-e02d-4de0-a7d2-904ebbacc93d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D27705573-59f1e97e-e02d-4de0-a7d2-904ebbacc93d%26entityType%3Dcollection%26workspaceId%3D1e4561c5-2d84-491a-a97a-5e7ed68f20a6)
+---
+
+Happy mocking! Simplify your development and testing workflows with this tool. For questions or issues, [open an issue](https://github.com/chtgupta/mock_api_backend/issues).