You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This guide provides comprehensive instructions for setting up the Document Knowledge Mining Solution Accelerator for local development across Windows, Linux, and macOS platforms.
3
+
This guide provides comprehensive instructions for setting up the Document Knowledge Mining Solution Accelerator for local development on Windows.
If you prefer or need to use the Azure Portal instead of CLI commands:
252
+
253
+
1. Sign in to the [Azure Portal](https://portal.azure.com).
254
+
2. Navigate to your **Resource Group** where services are deployed.
255
+
3. For each resource, assign the required roles:
256
+
257
+
**App Configuration**
258
+
- Go to **Access control (IAM)** → **Add role assignment**
259
+
- Assign role: `App Configuration Data Reader`
260
+
- Assign to: Your user account
261
+
262
+
**Storage Account**
263
+
- Go to **Access control (IAM)** → **Add role assignment**
264
+
- Assign the following roles to your user account:
265
+
-`Storage Blob Data Contributor`
266
+
-`Storage Queue Data Contributor`
267
+
268
+
**Azure AI Search**
269
+
- Go to **Access control (IAM)** → **Add role assignment**
270
+
- Assign the following roles to your user account:
271
+
-`Search Index Data Contributor`
272
+
-`Search Service Contributor`
273
+
274
+
**Azure OpenAI**
275
+
- Go to **Access control (IAM)** → **Add role assignment**
276
+
- Assign role: `Cognitive Services OpenAI User`
277
+
- Assign to: Your user account
278
+
279
+
**Azure AI Document Intelligence**
280
+
- Go to **Access control (IAM)** → **Add role assignment**
281
+
- Assign role: `Cognitive Services User`
282
+
- Assign to: Your user account
283
+
281
284
**Note**: RBAC permission changes can take 5-10 minutes to propagate. If you encounter "Forbidden" errors after assigning roles, wait a few minutes and try again.
282
285
283
286
## Step 3: Backend Setup & Run Instructions
@@ -309,8 +312,6 @@ Navigate to the cloned repository and open the following solution files from Vis
> If you were unable to assign roles using the Azure CLI commands in Step 2, you can use the Azure Portal as an alternative method.
369
-
> These roles are required only for local debugging and development. For production, ensure proper RBAC policies are applied.
370
-
371
-
1. Sign in to the [Azure Portal](https://portal.azure.com).
372
-
2. Navigate to your **Resource Group** where services are deployed.
373
-
3. For each resource, assign the required roles:
374
-
375
-
#### App Configuration
376
-
- Go to **Access control (IAM)** → **Add role assignment**
377
-
- Assign role: `App Configuration Data Reader`
378
-
- Assign to: Your user account
379
-
380
-
#### Storage Account
381
-
- Go to **Access control (IAM)** → **Add role assignment**
382
-
- Assign the following roles to your user account:
383
-
-`Storage Blob Data Contributor`
384
-
-`Storage Queue Data Contributor`
385
-
386
-
#### Azure AI Search
387
-
- Go to **Access control (IAM)** → **Add role assignment**
388
-
- Assign the following roles to your user account:
389
-
-`Search Index Data Contributor`
390
-
-`Search Service Contributor`
391
-
392
-
#### Azure OpenAI
393
-
- Go to **Access control (IAM)** → **Add role assignment**
394
-
- Assign role: `Cognitive Services OpenAI User`
395
-
- Assign to: Your user account
396
-
397
-
#### Azure AI Document Intelligence
398
-
- Go to **Access control (IAM)** → **Add role assignment**
399
-
- Assign role: `Cognitive Services User`
400
-
- Assign to: Your user account
401
-
402
-
**Remember**: RBAC permission changes can take 5-10 minutes to propagate.
403
-
404
-
---
405
-
406
-
### 3.5. Update Kernel Memory Endpoint in Azure App Configuration
363
+
### 4.2. Update Kernel Memory Endpoint in Azure App Configuration
407
364
408
365
> **Important:**
409
366
> The following change is only for local development and debugging.
@@ -424,20 +381,27 @@ Copy-Item Deployment\appconfig\aiservice\appsettings.Development.json.template A
424
381
```
425
382
6. Apply the changes.
426
383
427
-
---
428
-
**After running both solutions, two terminal windows will appear. Once the backend starts successfully, Swagger will start at http://localhost:9001. You can now validate the API endpoints from the Swagger UI to ensure that the backend is running correctly.**
429
-
430
384
> **Note:**
431
385
> Always revert the Kernel Memory endpoint value back to `http://kernelmemory-service` before running the application in Azure.
432
386
433
-
---
387
+
### 4.3. Run the Backend Services
388
+
389
+
1. In Visual Studio, run both solutions (KernelMemory and Microsoft.GS.DPS) by pressing **F5** or clicking the **Start** button.
390
+
2. Two terminal windows will appear showing the service logs.
391
+
3. Once both services start successfully:
392
+
- **Kernel Memory Service** will be available at: http://localhost:9001
393
+
- **Backend API** will be available at: https://localhost:52190
394
+
- **Swagger UI** will open automatically at http://localhost:52190 for API validation
395
+
396
+
> **⚠️ Important:** Keep both terminal windows open while the services are running. Do not close them until you're done with development.
434
397
398
+
---
435
399
436
-
## Step 4: Frontend Setup & Run Instructions
400
+
## Step 5: Frontend Setup & Run Instructions
437
401
438
-
### 4.1. Open the repo in **VS Code**.
402
+
### 5.1. Open the repo in **VS Code**.
439
403
440
-
### 4.2. Create `.env` file from template
404
+
### 5.2. Create `.env` file from template
441
405
442
406
Navigate to the `App/frontend-app` folder and create the `.env` file:
443
407
@@ -446,12 +410,10 @@ Navigate to the `App/frontend-app` folder and create the `.env` file:
446
410
cd "Document-Knowledge-Mining-Solution-Accelerator"
447
411
448
412
# Copy the template file
449
-
cp Deployment/appconfig/frontapp/.env.template App/frontend-app/.env # Linux
450
-
# or
451
-
Copy-Item Deployment\appconfig\frontapp\.env.template App\frontend-app\.env # Windows PowerShell
Before installing dependencies, verify that Node.js (LTS) and Yarn are already installed from Step 1:
466
428
@@ -475,17 +437,17 @@ yarn -v
475
437
> corepack prepare yarn@stable --activate
476
438
> ```
477
439
478
-
### 4.5. Install frontend dependencies
440
+
### 5.5. Install frontend dependencies
479
441
480
-
```bash
442
+
```powershell
481
443
# From repository root, navigate to frontend directory
482
-
cd App/frontend-app
444
+
cd App\frontend-app
483
445
484
446
# Install dependencies
485
447
yarn install
486
448
```
487
449
488
-
### 4.6. Start the application
450
+
### 5.6. Start the application
489
451
490
452
```powershell
491
453
yarn start
@@ -511,13 +473,6 @@ You're now ready to run and debug the application locally!
511
473
- While running the Kernel solution, if you encounter an error such as ``server not responded`` or ``server not found``, it usually indicates that the required resource is not responding.
512
474
- Ensure that the necessary **Kubernetes services** are running. If not, start the Kubernetes service and then run the Kernel solution again.
0 commit comments