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: README.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,6 +72,9 @@ Follow the quick deploy steps on the deployment guide to deploy this solution to
72
72
[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
73
73
<br/><br/>
74
74
75
+
**For Local Development:**
76
+
-[Local Development Setup Guide](docs/LocalDevelopmentSetup.md) - Comprehensive setup instructions for Windows, Linux, and macOS
77
+
75
78
| [](https://codespaces.new/microsoft/document-generation-solution-accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/document-generation-solution-accelerator) | [&message=Open&color=blue&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/azure/?vscode-azure-exp=foundry&agentPayload=eyJiYXNlVXJsIjogImh0dHBzOi8vcmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbS9taWNyb3NvZnQvZG9jdW1lbnQtZ2VuZXJhdGlvbi1zb2x1dGlvbi1hY2NlbGVyYXRvci9yZWZzL2hlYWRzL21haW4vaW5mcmEvdnNjb2RlX3dlYiIsICJpbmRleFVybCI6ICIvaW5kZXguanNvbiIsICJ2YXJpYWJsZXMiOiB7ImFnZW50SWQiOiAiIiwgImNvbm5lY3Rpb25TdHJpbmciOiAiIiwgInRocmVhZElkIjogIiIsICJ1c2VyTWVzc2FnZSI6ICIiLCAicGxheWdyb3VuZE5hbWUiOiAiIiwgImxvY2F0aW9uIjogIiIsICJzdWJzY3JpcHRpb25JZCI6ICIiLCAicmVzb3VyY2VJZCI6ICIiLCAicHJvamVjdFJlc291cmNlSWQiOiAiIiwgImVuZHBvaW50IjogIiJ9LCAiY29kZVJvdXRlIjogWyJhaS1wcm9qZWN0cy1zZGsiLCAicHl0aG9uIiwgImRlZmF1bHQtYXp1cmUtYXV0aCIsICJlbmRwb2ludCJdfQ==) |
Copy file name to clipboardExpand all lines: docs/DeploymentGuide.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -244,6 +244,9 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
244
244
7. You can now delete the resources by running `azd down`, if you are done trying out the application.
245
245
>**Note:** If you deployed with `enableRedundancy=true` and Log Analytics workspace replication is enabled, you must first disable replication before running `azd down`else resource group delete will fail. Follow the steps in [Handling Log Analytics Workspace Deletion with Replication Enabled](./LogAnalyticsReplicationDisable.md), waituntil replication returns `false`, then run `azd down`.
246
246
247
+
248
+
>**Note:** To set up and run the application locally for development, see the [Local Development Setup Guide](./LocalDevelopmentSetup.md).
249
+
247
250
### 🛠️ Troubleshooting
248
251
If you encounter any issues during the deployment process, please refer [troubleshooting](../docs/TroubleShootingSteps.md) document for detailed steps and solutions
Copy file name to clipboardExpand all lines: docs/LocalDevelopmentSetup.md
+118-4Lines changed: 118 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Local Debugging Setup
1
+
# Local Development Setup Guide
2
2
3
3
Follow the steps below to set up and run the **Document-Generation-Solution-Accelerator** locally.
4
4
@@ -42,10 +42,14 @@ Choose a location on your local machine where you want to store the project file
42
42
code .
43
43
```
44
44
45
-
## Local Setup/Debugging
45
+
## Local Setup/Deplpoyment
46
46
47
47
Follow these steps to set up and run the application locally:
48
48
49
+
## Local Deployment:
50
+
51
+
You can refer the local deployment guide here: [Local Deployment Guide](https://github.com/microsoft/document-generation-solution-accelerator/blob/main/docs/DeploymentGuide.md)
52
+
49
53
### 1. Open the App Folder
50
54
Navigate to the `src` directory of the repository using Visual Studio Code.
51
55
@@ -58,6 +62,17 @@ Navigate to the `src` directory of the repository using Visual Studio Code.
58
62
provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
59
63
file. To get your `<env-name>` run `azd env list` to see which env is default.
60
64
65
+
> **Note**: After adding all environment variables to the .env file, update the value of **'APP_ENV'** from:
66
+
```
67
+
APP_ENV="Prod"
68
+
```
69
+
**to:**
70
+
```
71
+
APP_ENV="Dev"
72
+
```
73
+
74
+
This change is required for running the application in local development mode.
75
+
61
76
### 3. Start the Application
62
77
- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
> **Note**: Make sure your virtual environment is activated before running these commands. You should see `(.venv)` in your terminal prompt when the virtual environment is active.
135
163
136
-
The App will run on `http://127.0.0.1:50505/#/` by default.
164
+
The App will run on `http://127.0.0.1:50505/#/` by default.
0 commit comments