Skip to content

Local Development

This guide will cover how to setup local development environment to add custom templates to AzureTRE and deploy AzureTRE from the local machine.

Local Development Setup

Prerequisites

To deploy an Azure TRE instance, the following assets and tools are required:

Development container

The AzureTRE Deployment solution contains a development container with all the required tooling to develop and deploy the AzureTRE and your custom templates to it. To deploy and extend an AzureTRE instance using the provided development container you will also need:

The files in AzureTRE Deployment repo for the dev container are located in /.devcontainer/ folder.

Having the prerequisites and the development container, to start local development follow the next steps:

  1. Clone the project you have created from the AzureTRE Deployment template git clone <your_project>
  2. Open it in Visual Studio Code
  3. VSCode will recognize the devcontainer is set up in and will ask to reopen in Devcontainer: Open in devcontainer

After the devcontainer is built, you will see the AzureTRE folder which you can use as a reference for your templates. In addition the sample.env files will be added.

Local Deployment

To run AzureTRE deploy locally:

  1. Open your project in VScode devcontainer.
  2. Fill in all the required configuration. Follow this guide to set it up.
  3. run make all

Tip

The Makefile in the AzureTRE deployment repository sources the make commands from AzureTRE that it references. This allows you to add your commands and also use the same make commands used in the AzureTRE.

Having all the env vars in place:

How to Contribute to our Documentation

If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.

You can find our existing documentation issues on GitHub by clicking on the link below:

Existing Documentation Issues

Or, you can raise a new issue by clicking on this link:

Report an Issue or Make a Suggestion

Thank you for your patience and support!