Skip to content
southernsun edited this page Apr 5, 2024 · 12 revisions

🚧 This page is a work in progress - feel free to improve or ask questions 🚧

This page provides basic instructions on how to deploy apps built using the template.

The template includes a built-in CI/CD workflow to automatically build, test, and deploy your app. This workflow has been built using GitHub Actions, so in order to leverage it, you will first need to create a new GitHub repository for your project (it must be a public repository for free/personal accounts). Once complete, follow the steps below to set up your environment and deploy your app to Azure. If you run into any problems, be sure to review the resources included at the end of this page.

Background

The deployment scripts are build around the concept of Trunk-Based Development (TBD), more about this approach can be found on the 'ADR-002: Adopting Trunk‐Based Development for Branching Strategy' Wiki page.

Prerequisites

Install the following before continuing:

Also make sure the 'Microsoft.KeyVault' resource provider is registered on your Azure subscription

Sign into Azure

Sign into your Azure account using PowerShell and the Azure CLI:

az login --use-device-code

NOTE: You need to have an active subscription.

Sign into GitHub

Sign into your GitHub account using PowerShell and the GitHub CLI:

gh auth login

Automated Setup

The template includes a setup script to automate the configuration of GitHub and Azure.

Make sure you edit the .scripts/setup.ps1 first to specify which Azure Region you want to use

$AzureLocation = "australiaeast"

Run the following commands to get started:

cd .scripts
./setup.ps1

Run Workflow

The workflow will kick off automatically when you push changes to main. When it does, it will build, test, and deploy the solution to Azure.

Resources

The following resources are highly recommended: