This is the template README for what is expected in submitted templates.

Note

This is a work in progress. This note will be removed once it's finalized

Project Name

(Longer Description, as compared to the GitHub "about" section of the project) (make sure to highlight the use case!) Sample application code is included in this project. You can use or modify this app code or you can rip it out and include your own.

Features

This project framework provides the following features:

• Feature 1
• Feature 2
• ...

Architecture Diagram

Include a diagram describing the application

Demo Video (optional)

(Embed demo video here)

Getting Started

Prerequisites

(ideally very short, if any)

• Install azd
  • Windows: winget install microsoft.azd
  • Linux: curl -fsSL https://aka.ms/install-azd.sh | bash
  • MacOS: brew tap azure/azd && brew install azd
• OS
• Library version
• This model uses [MODEL 1] and [MODEL 2] which may not be available in all Azure regions. Check for up-to-date region availability and select a region during deployment accordingly
  • We recommend using [SUGGESTED REGION]
• ...

Installation

(ideally very short)

• npm install [package name]
• mvn install
• ...

Quickstart

(Add steps to get up and running quickly)

1. Clone the repository and intialize the project: azd init [name-of-repo]
2. ...
3. Provision and deploy the project to Azure: azd up
4. Set up CI/CD with azd pipeline config
5. (Add steps to start up the sample app)

Local Development

Describe how to run and develop the app locally

Costs

You can estimate the cost of this project's architecture with Azure's pricing calculator

• [Azure Product] - [plan type] link to pricing for product

Security Guidelines

TODO: team will add the guidelines here for best security practices.

Each template has either Managed Identity or Key Vault built in to eliminate the need for developers to manage these credentials. Applications can use managed identities to obtain Microsoft Entra tokens without having to manage any credentials. Additionally, we have added a GitHub Action tool that scans the infrastructure-as-code files and generates a report containing any detected issues. To ensure best practices in your repo we recommend anyone creating solutions based on our templates ensure that the Github secret scanning setting is enabled in your repos.

Resources

(Any additional resources or related projects)

• Link to supporting information
• Link to similar sample
• Develop Python apps that use Azure AI services
• ...