Skip to content

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.

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 1 commit into from
Aug 13, 2025
Merged

docs: added readme for local setup #646

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 32 additions & 0 deletions docs/LocalSetupGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Guide to local development

## Requirements:

- Python 3.10 or higher + PIP
- Azure CLI, and an Azure Subscription
- Visual Studio Code IDE

## Local Setup:

Follow these steps to set up and run the application locally:

### 1. Open the src Folder
Navigate to the `src` folder of the repository using Visual Studio Code.

### 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.
### 4. Start the Application
- Run `start.cmd` (Windows) or `start.sh` (Linux/Mac) to:
- Install backend dependencies.
- 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.
### 5. Access the Application
Once the app is running, open your browser and navigate to [http://127.0.0.1:5000](http://127.0.0.1:5000).