Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
4 changes: 3 additions & 1 deletion .idea/aaz-dev-tools.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

93 changes: 93 additions & 0 deletions docs/pages/usage/local_dev_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
layout: page
title: Local Development Guide
permalink: /pages/usage/local-dev-guide/
weight: 105
---

## Prerequisites

- [Python 3.9+](https://www.python.org/downloads/)
- [Node.js 18+](https://nodejs.org/)
- [pnpm](https://pnpm.io/installation)

---

## Setup

**Create a virtual environment (if required):**

- ```bash
python -m venv .venv
```

**Activate venv:**

- PowerShell

```powershell
.\.venv\Scripts\Activate.ps1
```

- Bash

```bash
source .venv/bin/activate
```

## API (Backend)

Set environment variables (while the virtual environment is active):

- PowerShell

```powershell
# Replace <USER_HOME> with your user folder or path to the repos
$env:AAZ_PATH = "<USER_HOME>/aaz"
$env:AAZ_SWAGGER_PATH = "<USER_HOME>/azure-rest-api-specs"
$env:AAZ_SWAGGER_MODULE_PATH = "<USER_HOME>/azure-rest-api-specs/specification"
$env:AAZ_CLI_PATH = "<USER_HOME>/azure-cli"
$env:AAZ_CLI_EXTENSION_PATH = "<USER_HOME>/azure-cli-extensions"

$env:FLASK_APP="aaz_dev.app.app:create_app"
```

- Bash

```bash
# Replace <USER_HOME> with your user folder or path to the repos
export AAZ_PATH="<USER_HOME>/aaz"
export AAZ_SWAGGER_PATH="<USER_HOME>/azure-rest-api-specs"
export AAZ_SWAGGER_MODULE_PATH="<USER_HOME>/azure-rest-api-specs/specification"
export AAZ_CLI_PATH="<USER_HOME>/azure-cli"
export AAZ_CLI_EXTENSION_PATH="<USER_HOME>/azure-cli-extensions"

export FLASK_APP="aaz_dev.app.app:create_app"
```

**Start application:**

- ```
flask run --reload --port 5000
```

## Frontend:

- Install dependencies

```
pnpm install
pnpm build:typespec
pnpm build:web
pnpm run bundle


cd src/web
pnpm install
```

- Run front-end dev server (from `src/web`)

```
pnpm run dev
```
Loading