Skip to content

docs: Added changes in readme file related to SFI #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Roopan-Microsoft merged 3 commits into from
Aug 11, 2025
Merged

docs: Added changes in readme file related to SFI #533

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8cbbb2
Update DeploymentGuide.md
Atulku-Microsoft Aug 7, 2025
0f730cb
Update DeploymentGuide.md for local development & debugging instructions
Prajwal-Microsoft Aug 11, 2025
ebf5fab
Update DeploymentGuide.md for local development & debugging instructions
Prajwal-Microsoft Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/DeploymentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,14 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain

- Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.

## Environment configuration for local development & debugging
> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**.
Copy link

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase 'Use dev to enable to use Azure CLI credential' contains a grammatical error. It should be 'Use dev to enable Azure CLI credential' or 'Use dev to use Azure CLI credential'.

Suggested change
> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**.
> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase 'when using dev in local' should be 'when using dev locally' for better grammar.

Suggested change
> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**.
> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev locally**.

Copilot uses AI. Check for mistakes.
To configure your environment, follow these steps:
1. Navigate to the `src` folder.
2. Create a `.env` file based on the `.env.sample` file.
3. Fill in the `.env` file using the deployment output or by checking the Azure Portal under "Deployments" in your resource group.
4. Ensure that `APP_ENV` is set to "**dev**" in your `.env` file.

## Next Steps
Now that you've completed your deployment, you can start using the solution.

Expand Down
Loading