Skip to content

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

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
merged 2 commits into from
Aug 7, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
707f4cb
Update LocalDeployment.md
Atulku-Microsoft Aug 5, 2025
e261db6
Update DeploymentGuide.md
Atulku-Microsoft Aug 5, 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
3 changes: 2 additions & 1 deletion docs/DeploymentGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,11 +345,12 @@ The files for the dev container are located in `/.devcontainer/` folder.

5. **Create a `.env` file:**

- Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
Copy link

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

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

Use forward slashes for file paths in documentation to ensure cross-platform compatibility. Change src\backend to src/backend.

Suggested change
- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
- Navigate to the `src/backend` folder and create a `.env` file based on the provided `.env.sample` file.

Copilot uses AI. Check for mistakes.


6. **Fill in the `.env` file:**

- Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
- Make sure to set APP_ENV to "**dev**" in `.env` file.

7. **(Optional) Set up a virtual environment:**

Expand Down
3 changes: 2 additions & 1 deletion docs/LocalDeployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,12 @@ The files for the dev container are located in `/.devcontainer/` folder.
6. **Create a `.env` file:**
- Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
7. **Fill in the `.env` file:**
- Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
- Make sure to set APP_ENV to "**dev**" in `.env` file.
8. **(Optional) Set up a virtual environment:**
Expand Down
Loading