Framework quick-starts

Deploy an app built with any of the supported frameworks — creating the site, the build settings for that framework, and the first deployment.

These quick-starts are for deploying a web app that isn't a commerce storefront — a documentation site, a landing page, an app shell. Each one covers creating the app, the build settings for that framework, and the first deployment.

Building a commerce storefront instead? Start with Getting started, which scaffolds a theme rather than a bare app.

The shape of every quick-start

All of them follow the same six steps. The per-framework pages differ only in step 4 — the build settings.

  1. In Cockpit, go to Experience Studio → Sites and create a new site, choosing the Git path.
  2. Connect your GitHub account and select the repository to deploy.
  3. Pick the production branch and the root directory in that repository.
  4. Confirm the framework, install command, build command and output directory. The per-framework page below has the right values; the full table is in Build configuration.
  5. Add any environment variables the app needs — see Environment variables.
  6. Deploy. The first build starts immediately; once it is ready, the site is reachable at its generated domain.

From then on, a push to the production branch builds and activates, and a push to any other branch gets a preview. See Deploy from Git.

The frameworks

Next.js

ssr or static — the output directory differs between them.

Nuxt

ssr or static — static builds with npm run generate.

SvelteKit

ssr or static, chosen by the adapter package.

Angular

ssr or static, via @angular/ssr/node.

Astro

ssr or static, chosen by the adapter.

Remix

ssr or static, set on the Vite plugin.

TanStack Start

ssr by default; static via prerendering.

React

static. Set a fallback file for client-side routes.

Vue

static. Set a fallback file for client-side routes.

Flutter

static, from flutter build web.

React Native

static, for the web target.

Vanilla JS

static. No framework detected, no build assumed.

Not listed but supported: Analog, Lynx and Vite build with no quick-start page of their own — the defaults in Build configuration are enough.

Related

  • Starting points — the three ways to begin a project, including the reference theme
  • Frameworks — the fifteen supported frameworks and how the adapter is detected
  • Build configuration — the default install command, build command and output directory per framework
  • Rendering — SSR versus static, and the per-framework configuration for each
  • Deploy from Git — the push-to-deploy workflow in full
Was this page helpful?