From 1e003f477d61aa4fc2281f9d9ea949b6cdfcbc81 Mon Sep 17 00:00:00 2001 From: Angad Sethi Date: Mon, 6 Oct 2025 16:39:40 +0530 Subject: [PATCH] feat(setup): add optional frontend setup instructions to macOS, Windows, and Linux guides --- docs/docs/setup/LINUX.md | 18 ++++++++++++++++++ docs/docs/setup/MAC.md | 18 ++++++++++++++++++ docs/docs/setup/WINDOWS.md | 18 ++++++++++++++++++ 3 files changed, 54 insertions(+) diff --git a/docs/docs/setup/LINUX.md b/docs/docs/setup/LINUX.md index ba16c87e4..272f15ad0 100644 --- a/docs/docs/setup/LINUX.md +++ b/docs/docs/setup/LINUX.md @@ -66,6 +66,24 @@ dapr init --runtime-version 1.16.0 --slim dapr --version ``` +### 5. Setup Frontend (Optional) + +> [!NOTE] +> This step is only required if you plan to write and implement config maps for workflow setup forms. + +Install the frontend playground for your application: + +```bash +# Create the frontend static directory +mkdir -p frontend/static + +# Install the app playground +npx @atlanhq/app-playground install-to frontend/static +``` + +> [!NOTE] +> `frontend/static` is the default directory. You can change this to a different location, but you'll need to update the path in your workflow definition accordingly. + > [!NOTE] > Your development environment is now ready! Head over to our [Getting Started Guide](../guides/getting-started.md) to learn how to: > - Install project dependencies diff --git a/docs/docs/setup/MAC.md b/docs/docs/setup/MAC.md index 2d4565ed8..2efda5304 100644 --- a/docs/docs/setup/MAC.md +++ b/docs/docs/setup/MAC.md @@ -56,6 +56,24 @@ curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh dapr init --runtime-version 1.16.0 --slim ``` +### 5. Setup Frontend (Optional) + +> [!NOTE] +> This step is only required if you plan to write and implement config maps for workflow setup forms. + +Install the frontend playground for your application: + +```bash +# Create the frontend static directory +mkdir -p frontend/static + +# Install the app playground +npx @atlanhq/app-playground install-to frontend/static +``` + +> [!NOTE] +> `frontend/static` is the default directory. You can change this to a different location, but you'll need to update the path in your workflow definition accordingly. + > [!NOTE] > Your development environment is now ready! Head over to our [Getting Started Guide](../guides/getting-started.md) to learn how to: > - Install project dependencies diff --git a/docs/docs/setup/WINDOWS.md b/docs/docs/setup/WINDOWS.md index ccded0bc3..1ad20871e 100644 --- a/docs/docs/setup/WINDOWS.md +++ b/docs/docs/setup/WINDOWS.md @@ -72,6 +72,24 @@ dapr init --runtime-version 1.16.0 --slim dapr --version ``` +### 4. Setup Frontend (Optional) + +> [!NOTE] +> This step is only required if you plan to write and implement config maps for workflow setup forms. + +Install the frontend playground for your application: + +```powershell +# Create the frontend static directory +New-Item -ItemType Directory -Force -Path "frontend\static" + +# Install the app playground +npx @atlanhq/app-playground install-to frontend/static +``` + +> [!NOTE] +> `frontend/static` is the default directory. You can change this to a different location, but you'll need to update the path in your workflow definition accordingly. + > [!NOTE] > Your development environment is now ready! Head over to our [Getting Started Guide](../guides/getting-started.md) to learn how to: > - Install project dependencies