Develop an App Locally v2

Download a configured sample, run it over local HTTPS, and test both its raw frontend and embedded Console behavior against a Test Environment.

Download and install

Open Settings → Manage Apps.
Click Download a sample App.
Select the development Site and Test Environment.
Optionally select a Cookie-based API Key to generate an openapi.yml containing its permitted Workflow routes.
Select the OpenAPI version and download the project.
Extract it, open it in your IDE, and run npm install.

Confirm development context

Review .env.local:

FG_DEV_TENANT=yourTenantKey
FG_DEV_SITE=yourSiteKey
FG_DEV_ENVIRONMENT=yourEnvironmentKey

These values select the Console debug context. Keep them pointed at a safe Environment and do not add API-key secrets or Connection credentials to frontend environment files.

Run both views

Run npm run dev.
Open the raw local HTTPS tab generated by the sample.
Accept the development certificate warning.
Open or refresh the generated Console debug tab.
Confirm that the embedded App initializes and receives the intended Site, user, and Environment context.

Trust the local certificate before diagnosing a blank embedded frame. The SDK requires an HTTPS embedded host response for normal initialization.

Build a backend call

Use openapi.yml to identify the HTTP Method and relative Workflow path. Invoke it through Flowgear.Sdk.invoke, not direct fetch or axios, in embedded mode.

Test small inputs and inspect both browser behavior and Workflow logs. Confirm alerts, dialogs, deep-link synchronization, theme changes, and selected-Environment behavior that the App uses.

Change targets safely

When switching Site or Environment, update the development values, restart the dev server when required, and obtain a matching Cookie-based API Key/OpenAPI definition. The selected Environment must contain compatible published Workflows, Connections, status, and user authorization.