Skip to content

Commit 4104ac6

Browse files
fix: added Dev conatainer in Local Deployment Read Me file for this Project
1 parent 1841012 commit 4104ac6

File tree

2 files changed

+41
-6
lines changed

2 files changed

+41
-6
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@
2424
]
2525
}
2626
},
27-
"forwardPorts": [
28-
8000,
29-
3000
30-
],
27+
3128
"remoteUser": "vscode",
3229
"hostRequirements": {
3330
"memory": "8gb"

documentation/LocalDeployment.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,44 @@
66
- Azure CLI, and an Azure Subscription
77
- Visual Studio Code IDE
88

9+
# Local setup
10+
11+
> **Note for macOS Developers**: If you are using macOS on Apple Silicon (ARM64) the DevContainer will **not** work. This is due to a limitation with the Azure Functions Core Tools (see [here](https://github.com/Azure/azure-functions-core-tools/issues/3112)). We recommend using the [Non DevContainer Setup](./NON_DEVCONTAINER_SETUP.md) instructions to run the accelerator locally.
12+
13+
The easiest way to run this accelerator is in a VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers):
14+
15+
1. Start Docker Desktop (install it if not already installed)
16+
1. Open the project:
17+
[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
18+
19+
1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window
20+
21+
## Detailed Development Container setup instructions
22+
23+
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Chat With Your Data accelerator using the provided development container you will also need:
24+
25+
* [Visual Studio Code](https://code.visualstudio.com)
26+
* [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
27+
28+
If you are running this on Windows, we recommend you clone this repository in [WSL](https://code.visualstudio.com/docs/remote/wsl)
29+
30+
```cmd
31+
git clone https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator
32+
```
33+
34+
Open the cloned repository in Visual Studio Code and connect to the development container.
35+
36+
```cmd
37+
code .
38+
```
39+
40+
!!! tip
41+
Visual Studio Code should recognize the available development container and ask you to open the folder using it. For additional details on connecting to remote containers, please see the [Open an existing folder in a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container) quickstart.
42+
43+
When you start the development container for the first time, the container will be built. This usually takes a few minutes. **Please use the development container for all further steps.**
44+
45+
The files for the dev container are located in `/.devcontainer/` folder.
46+
947
## Local deployment and debugging:
1048

1149
1. **Clone the repository.**
@@ -59,8 +97,8 @@
5997
**Using a Different Database in Cosmos:**
6098
6199
You can set the solution up to use a different database in Cosmos. For example, you can name it something like autogen-dev. To do this:
62-
1. Change the environment variable **COSMOSDB_DATABASE** to the new database name.
63-
2. You will need to create the database in the Cosmos DB account. You can do this from the Data Explorer pane in the portal, click on the drop down labeled “_+ New Container_” and provide all the necessary details.
100+
1. Change the environment variable **COSMOSDB_DATABASE** to the new database name.
101+
2. You will need to create the database in the Cosmos DB account. You can do this from the Data Explorer pane in the portal, click on the drop down labeled “_+ New Container_” and provide all the necessary details.
64102
65103
6. **Create a `.env` file:**
66104

0 commit comments

Comments
 (0)