Skip to content

Commit 2c97098

Browse files
docs: Update local development setup sections and numbering
1 parent 9f2487c commit 2c97098

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/LocalDevelopmentSetup.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,10 @@ Follow these steps to set up and run the application locally:
231231

232232
You can refer the local deployment guide here: [Local Deployment Guide](https://github.com/microsoft/document-generation-solution-accelerator/blob/main/docs/DeploymentGuide.md)
233233

234-
### 1. Open the App Folder
234+
### 5.1. Open the App Folder
235235
Navigate to the `src` directory of the repository using Visual Studio Code.
236236

237-
### 2. Configure Environment Variables
237+
### 5.2. Configure Environment Variables
238238
- Copy the `.env.sample` file to a new file named `.env`.
239239
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
240240
- You can get all env value in your deployed resource group under App Service:
@@ -255,11 +255,11 @@ APP_ENV="Dev"
255255
This change is required for running the application in local development mode.
256256

257257

258-
### Required Azure RBAC Permissions
258+
### 5.3. Required Azure RBAC Permissions
259259

260260
To run the application locally, your Azure account needs the following role assignments on the deployed resources:
261261

262-
#### App Configuration Access
262+
#### 5.3.1. App Configuration Access
263263
```bash
264264
# Get your principal ID
265265
PRINCIPAL_ID=$(az ad signed-in-user show --query id -o tsv)
@@ -271,7 +271,7 @@ az role assignment create \
271271
--scope "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.AppConfiguration/configurationStores/<appconfig-name>"
272272
```
273273

274-
#### Cosmos DB Access
274+
#### 5.3.2. Cosmos DB Access
275275
```bash
276276
# Assign Cosmos DB Built-in Data Contributor role
277277
az cosmosdb sql role assignment create \
@@ -283,7 +283,7 @@ az cosmosdb sql role assignment create \
283283
```
284284
> **Note**: After local deployment is complete, you need to execute the post-deployment script so that all the required roles will be assigned automatically.
285285
286-
## Running with Automated Script
286+
### 5.4. Running with Automated Script
287287

288288
For convenience, you can use the provided startup scripts that handle environment setup and start both services:
289289

@@ -299,7 +299,7 @@ cd src
299299
chmod +x start.sh
300300
./start.sh
301301
```
302-
### Start the Application
302+
### 5.5. Start the Application
303303
- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
304304
- Install backend dependencies.
305305
- Install frontend dependencies.
@@ -312,7 +312,7 @@ chmod +x start.sh
312312

313313
> **📋 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**.
314314
315-
#### Step 1: Create Virtual Environment (Recommended)
315+
### 6.1. Create Virtual Environment (Recommended)
316316

317317
Open your terminal and navigate to the root folder of the project, then create the virtual environment:
318318

@@ -332,7 +332,7 @@ source .venv/bin/activate
332332

333333
> **Note**: After activation, you should see `(.venv)` in your terminal prompt indicating the virtual environment is active.
334334
335-
#### Step 2: Install Dependencies and Run
335+
### 6.2. Install Dependencies and Run
336336

337337
To develop and run the backend API locally:
338338

@@ -380,14 +380,14 @@ The App will run on `http://127.0.0.1:50505/#/` by default.
380380

381381
Before using the application, confirm all services are running correctly:
382382

383-
### Terminal Status Checklist
383+
### 7.1. Terminal Status Checklist
384384

385385
| Terminal | Service | Command | Expected Output | URL |
386386
|----------|---------|---------|-----------------|-----|
387387
| **Terminal 1** | Backend API | `python -m uvicorn app:app --port 50505 --reload` | `INFO: Application startup complete` | http://127.0.0.1:50505 |
388388
| **Terminal 2** | Frontend (Dev) | `npm run dev` | `Local: http://localhost:5173/` | http://localhost:5173 |
389389

390-
### Quick Verification
390+
### 7.2. Quick Verification
391391

392392
**1. Check Backend API:**
393393
```bash
@@ -401,7 +401,7 @@ curl http://127.0.0.1:50505/health
401401
- Should see the Document Generation UI
402402
- If authentication is configured, you'll be redirected to Azure AD login
403403

404-
### Common Issues
404+
### 7.3. Common Issues
405405

406406
**Service not starting?**
407407
- Ensure you're in the correct directory (`src/` for backend)

0 commit comments

Comments
 (0)