From 4bb80624a93cb09e7f9e16553219fdcef66c1ce7 Mon Sep 17 00:00:00 2001 From: Chahat Gupta Date: Sat, 16 Sep 2023 23:19:06 +0530 Subject: [PATCH 1/2] Create readme.md --- readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..cfd94d8 --- /dev/null +++ b/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. + +Screenshot 2023-09-16 at 11 13 59 PM + +## 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). From dcdde4b48850074d9c2c702cbcf0ada51e02df9a Mon Sep 17 00:00:00 2001 From: Chahat Gupta Date: Sat, 16 Sep 2023 23:21:22 +0530 Subject: [PATCH 2/2] Update screenshot in readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index cfd94d8..7560f26 100644 --- a/readme.md +++ b/readme.md @@ -2,7 +2,7 @@ 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. -Screenshot 2023-09-16 at 11 13 59 PM +Screenshot 2023-09-16 at 11 13 59 PM ## Features