README.md

Name of Sample

One line blurb about this sample.

Contents

• Solution Overview
  • Background
  • Architecture
  • Technologies used
• Key Learnings
  • 1. Key Learnings 1
  • 2. Key Learnings 2
• Key Concepts
  • [EXAMPLE] Continuous Integration
  • [EXAMPLE] Continuous Delivery
• How to use the sample
  • Prerequisites
  • Setup and Deployment
    • Deployed Resources
• Known Issues, Limitations and Workarounds

---

Solution Overview

Background

Here is the background of the sample.

Architecture

The following is the overall architecture of the sample.

Technologies used

This sample uses:

• Microsoft Fabric

Key Learnings

The following are Key Learnings in this sample:

1. Key Learnings 1

2. Key Learnings 2

Key Concepts

Engineering concepts demonstrated.

[EXAMPLE] Continuous Integration

[EXAMPLE] Continuous Delivery

How to use the sample

Prerequisites

1. [EXAMPLE] Github account

Software pre-requisites if you don't use dev container

• [EXAMPLE] az cli x.y+

Software pre-requisites if you use dev container

EXAMPLE:

• Docker
• VSCode
• Visual Studio Code Remote Development Extension

1. Rename .envtemplate to devcontainer.env and update the values as explained in the Initial Setup section.
2. Open the project inside the vscode dev container.
3. cd into the e2e/<name-sample> or single-tech/<name-of-technology> folder and run ./deploy.sh inside the dev container terminal.

Setup and Deployment

IMPORTANT NOTE: As with all Azure deployments, this will incur associated costs. Remember to teardown all related resources after use to avoid unnecessary costs. See here for a list of deployed resources.

1. Initial Setup

2. Deploy Azure resources

Congratulations!! 🥳 You have successfully deployed the solution!

Deployed Resources

After a successful deployment, you should have the following resources:

Known Issues, Limitations and Workarounds

[If applicable] The following lists some limitations of the solution and associated deployment script: