From 0336c41130a5e9526acd5247b167782590449ddf Mon Sep 17 00:00:00 2001 From: Reza Nazari <127698692+reza-nzri@users.noreply.github.com> Date: Sun, 23 Feb 2025 22:24:28 +0100 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0ecdf2a..8922575 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ Welcome to **SapiensData API**! This RESTful API is designed to support the **Sa - **Swagger UI** for interactive API documentation and testing. - **Clean and Modular Architecture** optimized for ease of development and scalability. -## ๐Ÿ› ๏ธ Getting Started +
+

๐Ÿ› ๏ธ Getting Started

Follow these steps to set up and run the project on your local machine for development and testing. -### Prerequisites +
+

Prerequisites

Please ensure you have the following installed: @@ -26,7 +28,10 @@ Please ensure you have the following installed: - Sapiens API key to connect to and authorize the SapiensDataAPI subproject (identical to your `SAPIENS_API_KEY` variable from `Analytics/.env.dev`) - A Google Drive folder path -### ๐Ÿ”ง Setup Instructions +
+ +
+

๐Ÿ”ง Setup Instructions

1. **Open the Project in Visual Studio**: - Navigate to the `SapiensDataAPI` folder and open `SapiensData.API.sln`. @@ -60,7 +65,13 @@ cp .env.example .env 2. **Run the Application**: - Press `F5` or click the **Run** button in Visual Studio. The API will run on `https://localhost:5001` (or a different port if configured). -### ๐Ÿงช Testing +
+ +
+

๐Ÿงช Testing

- **Swagger UI** provides an interactive interface to test each API endpoint. - Use tools like [Postman](https://www.postman.com/) or [curl](https://curl.se/) for additional testing. + +
+