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
Copy file name to clipboardExpand all lines: docs/LocalDevelopmentSetup.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -231,10 +231,10 @@ Follow these steps to set up and run the application locally:
231
231
232
232
You can refer the local deployment guide here: [Local Deployment Guide](https://github.com/microsoft/document-generation-solution-accelerator/blob/main/docs/DeploymentGuide.md)
233
233
234
-
### 1. Open the App Folder
234
+
### 5.1. Open the App Folder
235
235
Navigate to the `src` directory of the repository using Visual Studio Code.
236
236
237
-
### 2. Configure Environment Variables
237
+
### 5.2. Configure Environment Variables
238
238
- Copy the `.env.sample` file to a new file named `.env`.
239
239
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
240
240
- You can get all env value in your deployed resource group under App Service:
@@ -255,11 +255,11 @@ APP_ENV="Dev"
255
255
This change is required for running the application in local development mode.
256
256
257
257
258
-
### Required Azure RBAC Permissions
258
+
### 5.3. Required Azure RBAC Permissions
259
259
260
260
To run the application locally, your Azure account needs the following role assignments on the deployed resources:
261
261
262
-
#### App Configuration Access
262
+
#### 5.3.1. App Configuration Access
263
263
```bash
264
264
# Get your principal ID
265
265
PRINCIPAL_ID=$(az ad signed-in-user show --query id -o tsv)
@@ -283,7 +283,7 @@ az cosmosdb sql role assignment create \
283
283
```
284
284
> **Note**: After local deployment is complete, you need to execute the post-deployment script so that all the required roles will be assigned automatically.
285
285
286
-
## Running with Automated Script
286
+
### 5.4. Running with Automated Script
287
287
288
288
For convenience, you can use the provided startup scripts that handle environment setup and start both services:
289
289
@@ -299,7 +299,7 @@ cd src
299
299
chmod +x start.sh
300
300
./start.sh
301
301
```
302
-
### Start the Application
302
+
### 5.5. Start the Application
303
303
- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
304
304
- Install backend dependencies.
305
305
- Install frontend dependencies.
@@ -312,7 +312,7 @@ chmod +x start.sh
312
312
313
313
> **📋 Terminal Reminder**: This section requires **two separate terminal windows** - one for the Backend API and one for the Frontend. Keep both terminals open while running. All commands assume you start from the **repository root directory**.
0 commit comments