diff --git a/docs/NON_DEVCONTAINER_SETUP.md b/docs/NON_DEVCONTAINER_SETUP.md new file mode 100644 index 000000000..3c39e2d09 --- /dev/null +++ b/docs/NON_DEVCONTAINER_SETUP.md @@ -0,0 +1,55 @@ +[Back to *Chat with your data* README](../README.md) + +# Non-DevContainer Setup + +If you are unable to run this accelerator using a DevContainer or in GitHub CodeSpaces, then you will need to install the following prerequisites on your local machine. + +- A code editor. We recommend [Visual Studio Code](https://code.visualstudio.com/), with the following extensions: + - [Azure Functions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions) + - [Azure Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-node-azure-pack) + - [Bicep](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) + - [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) + - [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) + - [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) **Optional** +- [Python 3.11](https://www.python.org/downloads/release/python-3119/) +- [Node.js LTS](https://nodejs.org/en) +- [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) +- [Azure Functions Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local) + +## Setup + +1. Review the contents of [.devcontainer/setupEnv.sh](../.devcontainer/setupEnv.sh) and then run it: + + ```bash + .devcontainer/setupEnv.sh + ``` + +1. Select the Python interpreter in Visual Studio Code: + + - Open the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P`). + - Type `Python: Select Interpreter`. + - Select the Python 3.11 environment created by Poetry. + +### Running the sample using the Azure Developer CLI (azd) + +The Azure Developer CLI (`azd`) is a developer-centric command-line interface (CLI) tool for creating Azure applications. + +1. Log in to Azure using `azd`: + + ``` + azd auth login + ``` + +1. Execute the `azd init` command to initialize the environment and enter the solution accelerator name when prompted: + + ``` + azd init -t Multi-Agent-Custom-Automation-Engine-Solution-Accelerator + ``` + +1. Run `azd up` to provision all the resources to Azure and deploy the code to those resources. + + ``` + azd up + ``` + + > Select your desired `subscription` and `location`. Wait a moment for the resource deployment to complete, click the website endpoint and you will see the web app page. diff --git a/next-steps.md b/next-steps.md index b68d0f3f1..120b779f0 100644 --- a/next-steps.md +++ b/next-steps.md @@ -17,7 +17,7 @@ To troubleshoot any issues, see [troubleshooting](#troubleshooting). ### Configure environment variables for running services -Environment variables can be configured by modifying the `env` settings in [resources.bicep](./infra/resources.bicep). +Environment variables can be configured by modifying the `env` settings in [resources.bicep](./infra/old/resources.bicep). To define a secret, add the variable as a `secretRef` pointing to a `secrets` entry or a stored KeyVault secret. ### Configure CI/CD pipeline @@ -42,7 +42,7 @@ To describe the infrastructure and application, `azure.yaml` along with Infrastr - modules/ # Library modules ``` -The resources declared in [resources.bicep](./infra/resources.bicep) are provisioned when running `azd up` or `azd provision`. +The resources declared in [resources.bicep](./infra/old/resources.bicep) are provisioned when running `azd up` or `azd provision`. This includes: