-
Notifications
You must be signed in to change notification settings - Fork 157
docs: added readme for local setup #646
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.
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
Conversation
There was a problem hiding this 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. |
Copilot
AI
Aug 13, 2025
There was a problem hiding this comment.
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.
- 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. | ||
|
Copilot
AI
Aug 13, 2025
There was a problem hiding this comment.
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).
- 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. | ||
|
Copilot
AI
Aug 13, 2025
There was a problem hiding this comment.
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.
- 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.
Purpose
Documentation improvements:
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?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information