Skip to content

LocalDebuggingSetup.md

Latest commit

 

History

History
136 lines (96 loc) · 4.37 KB

LocalDebuggingSetup.md

File metadata and controls

136 lines (96 loc) · 4.37 KB

Local Debugging Setup

Follow the steps below to set up and run the Document-Generation-Solution-Accelerator locally.

Prerequisites

Install these tools before you start:

Setup Steps

Clone the Repository

Choose a location on your local machine where you want to store the project files. We recommend creating a dedicated folder for your development projects.

Using Command Line/Terminal

  1. Open your terminal or command prompt. Navigate to your desired directory and Clone the repository:

    git clone https://github.com/microsoft/document-generation-solution-accelerator.git

  2. Navigate to the project directory:

    cd document-generation-solution-accelerator

  3. Open the project in Visual Studio Code:

    code .

Local Setup/Debugging

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

1. Open the App Folder

Navigate to the src directory of the repository using Visual Studio Code.

2. Configure Environment Variables

  • Copy the .env.sample file to a new file named .env.
  • Update the .env file with the required values from your Azure resource group in Azure Portal App Service environment variables.
  • You can get all env value in your deployed resource group under App Service: Enviorment Variables
  • Alternatively, if resources were provisioned using azd provision or azd up, a .env file is automatically generated in the .azure/<env-name>/.env file. To get your <env-name> run azd env list to see which env is default.

3. 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.
  • Alternatively, you can run the backend in debug mode using the VS Code debug configuration defined in .vscode/launch.json.

Running with Automated Script

For convenience, you can use the provided startup scripts that handle environment setup and start both services:

Windows:

cd src
.\start.cmd

macOS/Linux:

cd src
chmod +x start.sh
./start.sh

Running Backend and Frontend Separately

Step 1: Create Virtual Environment (Recommended)

Open your terminal and navigate to the root folder of the project, then create the virtual environment:

# Navigate to the project root folder
cd document-generation-solution-accelerator

# Create virtual environment in the root folder
python -m venv .venv

# Activate virtual environment (Windows)
.venv/Scripts/activate

# Activate virtual environment (macOS/Linux)
source .venv/bin/activate

Note: After activation, you should see (.venv) in your terminal prompt indicating the virtual environment is active.

Step 2: Install Dependencies and Run

To develop and run the backend API locally:

# Navigate to the API folder (while virtual environment is activated)
cd src/

# Upgrade pip
python -m pip install --upgrade pip

# Install Python dependencies
pip install -r requirements.txt

# Install Fronend Packages
cd src/frontend
npm install
npm run build

# Run the backend API
cd src/

start http://127.0.0.1:50505
call python -m uvicorn app:app --port 50505 --reload

Note: Make sure your virtual environment is activated before running these commands. You should see (.venv) in your terminal prompt when the virtual environment is active.

The App will run on http://127.0.0.1:50505/#/ by default.