|
6 | 6 | - Azure CLI, and an Azure Subscription |
7 | 7 | - Visual Studio Code IDE |
8 | 8 |
|
| 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 | +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): |
| 13 | + |
| 14 | +1. Start Docker Desktop (install it if not already installed) |
| 15 | +1. Open the project: |
| 16 | + [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) |
| 17 | + |
| 18 | +1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window |
| 19 | + |
| 20 | +## Detailed Development Container setup instructions |
| 21 | + |
| 22 | +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: |
| 23 | + |
| 24 | +* [Visual Studio Code](https://code.visualstudio.com) |
| 25 | +* [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) |
| 26 | + |
| 27 | +If you are running this on Windows, we recommend you clone this repository in [WSL](https://code.visualstudio.com/docs/remote/wsl) |
| 28 | + |
| 29 | +```cmd |
| 30 | +git clone https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator |
| 31 | +``` |
| 32 | + |
| 33 | +Open the cloned repository in Visual Studio Code and connect to the development container. |
| 34 | + |
| 35 | +```cmd |
| 36 | +code . |
| 37 | +``` |
| 38 | + |
| 39 | +!!! tip |
| 40 | + 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. |
| 41 | + |
| 42 | +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.** |
| 43 | + |
| 44 | +The files for the dev container are located in `/.devcontainer/` folder. |
| 45 | + |
9 | 46 | ## Local deployment and debugging: |
10 | 47 |
|
11 | 48 | 1. **Clone the repository.** |
|
0 commit comments