ToC: USER STORY | GETTING STARTED | HOW IT WORKS
Tip
Az AI Tip: Document what your solution does here.
This respository has been configured to support GitHub Codespace and DevContainers.
Warning
Do NOT git clone
the application under Windows and then open a DevContainer.
This would create issues with file end of lines. For DevContainer click on the button
above and let Visual Studio Code download the repository for you. Alternatively you
can also git clone
under Windows Subsystem for Linux (WSL) and ask Visual Studio Code to
Re-Open in Container
.
It is possible to work with a fully local setup.
- Azure CLI:
az
- Azure Developer CLI:
azd
- Python:
python
- UV:
uv
- Optionally Docker:
docker
Tip
Az AI Tip: Document here how to quickly deploy the solution. Try to reduce this to azd up
by
automating as much as possible. Have a look at main.bicep
and scripts
for examples of how to do
that
To deploy Az AI scaffolding tool test just run:
azd up
[!WARNING] The application automatically configures authentication to secure frontend To do so it creates an app registration in EntraID. If the account you are using to deploy the app does not have the required permissions, disable the preprovision script in azure.yaml
- TODO: How to run backend locally
- TODO: How to run frontend locally
- TODO : Observability
Tip
Az AI Tip: Document how the solution is used and operated here.
Optionally, if the section is too long, create a USER_MANUAL.md
file and
link to it from here.
Tip
Az AI Tip: Document the solution's architecture here.
Optionally, if the section is too long, create a ARCHITECTURE.md
file and
link to it from here.
Tip
Az AI Tip: For architecture diagrams, you can leverage the Markdown text diagramming capabilities available in GitHub. See example below.
architecture-beta
group solution(cloud)[Solution]
service frontend(server)[Frontend] in solution
service backend(server)[Backend] in solution
frontend:R --> L:backend
This project has adopted the Microsoft Open Source Code of Conduct.
Resources:
- Microsoft Open Source Code of Conduct
- Microsoft Code of Conduct FAQ
- Contact [email protected] with questions or concerns
For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
This project follows below responsible AI guidelines and best practices, please review them before using this project: