Skip to content

Update from code changes: clarify local build is optional for data apps #932

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update from code changes: clarify local build is optional for data apps #932

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
4 changes: 3 additions & 1 deletion guides/data-apps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,11 @@ The built output is intentionally excluded — the server rebuilds the app from
Once an app is on disk you can iterate on it locally:

1. Edit files under `src/`.
2. Optionally run `pnpm install && pnpm build` inside the app folder to check that the source compiles. This is a **local pre-check only** — if `pnpm install` fails in your environment (registry policies, no network), skip this step rather than fighting it; the server does its own build on upload and any build errors appear on the app's page.
2. Optionally run `pnpm install && pnpm build` inside the app folder to check that the source compiles. This is a **local pre-check only** — if `pnpm install` fails in your environment (registry policies, an unavailable pinned SDK version, no network, sandboxed shells), skip it and go straight to upload; the server does its own build on upload and any build errors appear on the app's page. Don't modify machine-wide configuration, `.npmrc` files, or the app's dependency files to force the local install through.
3. Run `lightdash upload --apps` to send the source back. The server rebuilds and publishes a new version.

A missing `node_modules` in an app folder is a normal state — the scaffolding files (`package.json`, `README.md`, `AGENTS.md`, `.claude/skills/`) stay on disk because they still work when your environment allows a local install, and the server rebuild is authoritative either way.

The bundled `.claude/skills/` and `AGENTS.md` files describe the SDK surface and this workflow so coding agents (Claude Code and similar) can help you edit apps locally without extra prompting.

### Uploading an app
Expand Down
Loading