Skip to content

Conversation

AjitPadhi-Microsoft
Copy link
Contributor

@AjitPadhi-Microsoft AjitPadhi-Microsoft commented Aug 13, 2025

Purpose

  • This pull request adds a new local development guide to the project documentation. The guide provides step-by-step instructions for setting up the application locally, including environment requirements, configuration, and running the app.

Documentation improvements:

  • Added a new LocalSetupGuide.md file with detailed instructions for setting up the development environment, configuring environment variables, using a Python virtual environment, and starting the application locally.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request adds comprehensive local development documentation to help developers set up the application in their local environment. The guide includes prerequisites, step-by-step setup instructions, and configuration details.

Key changes:

  • Added a new LocalSetupGuide.md file with detailed local development setup instructions
  • Provided clear requirements including Python 3.10+, Azure CLI, and Visual Studio Code
  • Included steps for environment configuration, virtual environment setup, and application startup

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

### 2. Configure Environment Variables
- Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
- Make sure to set APP_ENV to "**dev**" in `.env` file.
Copy link

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

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

The instruction should clarify the exact format for setting APP_ENV. Consider providing the complete line format, e.g., 'APP_ENV=dev' to make it clearer for developers.

Suggested change
- Make sure to set APP_ENV to "**dev**" in `.env` file.
- Make sure to set `APP_ENV=dev` in your `.env` file.

Copilot uses AI. Check for mistakes.


### 3. (Optional) Python Virtual Environment
- Navigate to the `src` folder, create and activate your virtual environment `venv` under `src` folder.

Copy link

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

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

This instruction lacks the specific commands needed to create and activate a virtual environment. Consider adding the actual commands: 'python -m venv venv' and 'source venv/bin/activate' (Linux/Mac) or 'venv\Scripts\activate' (Windows).

Suggested change
- Navigate to the `src` folder, then create and activate your virtual environment `venv`:
**Linux/Mac:**
```bash
python -m venv venv
source venv/bin/activate

Windows:

python -m venv venv
venv\Scripts\activate

Copilot uses AI. Check for mistakes.

- Install frontend dependencies.
- Build the frontend.
- Start the backend server.

Copy link

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

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

The instruction assumes these scripts exist but doesn't specify their location. Consider clarifying where these scripts are located (e.g., 'in the src folder') and what to do if they don't exist.

Suggested change
- In the `src` folder, run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
- Install backend dependencies.
- Install frontend dependencies.
- Build the frontend.
- Start the backend server.
> **Note:** If `start.cmd` or `start.sh` do not exist in the `src` folder, ensure you have checked out the correct branch or contact the repository maintainer for assistance.

Copilot uses AI. Check for mistakes.

@Prajwal-Microsoft Prajwal-Microsoft merged commit 484d6c2 into byoc-researcher Aug 13, 2025
6 checks passed
@AjitPadhi-Microsoft AjitPadhi-Microsoft deleted the psl-us-21984 branch October 9, 2025 09:26
@AjitPadhi-Microsoft AjitPadhi-Microsoft restored the psl-us-21984 branch October 9, 2025 09:27
@AjitPadhi-Microsoft AjitPadhi-Microsoft deleted the psl-us-21984 branch October 9, 2025 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants