> ## Documentation Index
> Fetch the complete documentation index at: https://getfloo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Build a Nuxt app on floo

> Deploy a Nuxt app with Postgres, sign-in, and a custom domain.

From a Nuxt 4 project on GitHub to a live app at `https://<app>.getfloo.app`, with managed Postgres, signed-in users, and your own domain.

New to floo? Start with the [Quickstart](https://getfloo.com/docs/introduction.md).

## What your agent controls

floo builds the `Dockerfile` in your repository. Add one that specifies the runtime for your app:

* The base image and the exact Node version.
* System packages, such as `ffmpeg` or Chromium for headless browsing, each one `apt-get install` line.
* The build steps and the start command.
* More services from the same repository, such as a background worker or a [cron job](https://getfloo.com/docs/guides/cron-jobs.md).

Declare services, managed Postgres, sign-in, and domains in `floo.app.toml`. Store secrets outside git.

## 1. Add a Dockerfile

`nuxt build` writes a self-contained Node server to `.output/`, with the dependencies it needs traced into `.output/server/node_modules`. The final image needs only that folder:

```dockerfile Dockerfile theme={null}
FROM node:22-slim AS build
WORKDIR /app
COPY package.json package-lock.json ./
RUN npm ci
COPY . .
RUN npm run build

FROM node:22-slim
WORKDIR /app
ENV NODE_ENV=production \
    HOST=0.0.0.0
COPY --from=build /app/.output ./.output
CMD ["node", ".output/server/index.mjs"]
```

The server reads `PORT` from the environment. `HOST=0.0.0.0` makes it listen on every interface, which floo needs to reach it. Add a `.dockerignore` listing `node_modules`, `.nuxt`, and `.output`.

## 2. Initialize the floo config

Install the CLI and sign in: `curl -fsSL https://getfloo.com/install.sh | bash`, then `floo auth login`. An agent can run the same journey over the HTTP API instead, starting from [getfloo.com/agents.md](https://getfloo.com/agents.md).

```bash theme={null}
floo init my-nuxt-app
```

For a single-service Nuxt app:

```toml floo.app.toml theme={null}
[app]
name = "my-nuxt-app"

[services.web]
type = "web"
path = "."
port = 3000
ingress = "public"
dev_command = "npm run dev -- --port 3000 --host 127.0.0.1"
```

After adding Postgres, set `migrate_command` under `[services.web]` to your migration tool, such as `"npx drizzle-kit migrate"`. The final stage above holds only `.output`, so copy the tool, its config, and the migration files into the image as well. It runs as a one-off job with the new image before traffic moves to it. A failed migration stops the deploy. Use [expand-then-contract migrations](https://getfloo.com/docs/guides/postgres.md#schema-portability-across-dev-and-prod) to keep the schema compatible with both old and new code.

## 3. Connect the repo and deploy

floo builds from your GitHub repository, not local files, so commit first. `floo deploy` pushes the commit and waits until the dev URL is live. The first time, it stops with one link if the floo GitHub App can't read the repository yet: a human opens it and installs the App on the account that owns the repository, then you run `floo deploy` again. See [Give floo access to your GitHub repository](https://getfloo.com/docs/introduction.md#2-give-floo-access-to-your-github-repository).

```bash theme={null}
git add . && git commit -m "feat: floo config + Dockerfile"
floo deploy --preflight
floo deploy
```

No GitHub repository? `floo deploy --hosted` has floo host the repository. See [Deploy without GitHub](https://getfloo.com/docs/deploy/without-github.md).

When it's done:

```bash theme={null}
floo apps show my-nuxt-app
```

> [!TIP]
>
> **Your Nuxt app is live** at `https://my-nuxt-app.getfloo.app`.
>
> Every `git push origin main` ships to dev.

## 4. Add a Postgres database

```toml floo.app.toml theme={null}
[managed.default]
type = "postgres"
```

```bash theme={null}
npm install postgres
git add . && git commit -m "feat: add postgres"
floo deploy --preflight
floo deploy
```

Preflight warns `MANAGED_CREDS_TO_WEB` because the web service receives the database credentials. That is expected when the web service queries the database.

`DATABASE_URL` is injected at runtime. Files in `server/utils/` are auto-imported into every server route:

```ts server/utils/db.ts theme={null}
import postgres from "postgres";

export const sql = postgres(process.env.DATABASE_URL!);
```

```ts server/api/time.get.ts theme={null}
export default defineEventHandler(async () => {
  const [{ now }] = await sql`select now()`;
  return { dbTime: now.toISOString() };
});
```

`postgres` connects on the first query and reads the TLS settings in the URL. Dev and prod each get a separate Postgres database and credentials, with no shared state.

## 5. Add per-user auth

Set `access_mode = "accounts"` and floo handles sign-in:

```toml floo.app.toml theme={null}
[app]
name = "my-nuxt-app"
access_mode = "accounts"
```

From the next deploy onward, floo's gateway:

* Redirects unauthenticated requests to a hosted login page.
* Validates the session cookie on every request.
* Injects identity headers into every request that reaches your Nuxt server.

Server routes read the headers, with no auth code, callback handlers, or session storage:

```ts server/utils/user.ts theme={null}
import type { H3Event } from "h3";

export function requireUser(event: H3Event) {
  const email = getRequestHeader(event, "x-floo-user-email");
  const id = getRequestHeader(event, "x-floo-user-id");
  if (!email || !id) {
    throw createError({ statusCode: 401, statusMessage: "Sign in required" });
  }
  return { email, id, name: getRequestHeader(event, "x-floo-user-name") ?? null };
}
```

```ts server/api/me.get.ts theme={null}
export default defineEventHandler((event) => requireUser(event));
```

Pages call the route with `useFetch`. During server rendering, `useFetch` to your own `/api` routes forwards the incoming request headers, identity headers included. Pages live in `app/pages/`, and `app/app.vue` must render `<NuxtPage />`; the starter's `app.vue` renders the welcome screen instead:

```vue app/app.vue theme={null}
<template>
  <NuxtPage />
</template>
```

```vue app/pages/index.vue theme={null}
<script setup lang="ts">
const { data: user } = await useFetch("/api/me");
</script>

<template>
  <p v-if="user">Signed in as {{ user.email }}</p>
</template>
```

Locally, run `floo dev --fixture-user` (see [section 7](#7-local-development-with-dev-credentials)) or send the headers yourself with `curl -H 'X-Floo-User-Email: you@example.com' ...`. Access modes and identity headers in full: [App sign-in](https://getfloo.com/docs/guides/app-auth.md).

## 6. Add a custom domain

Declare the domain in `floo.app.toml`:

```toml theme={null}
[domains."app.example.com"]
service = "web"
```

Commit and push, wait for that commit's dev deploy to go live, then release it
to prod and read the DNS records:

Replace `owner/repo` with your GitHub repository. For a floo-hosted project, see [Environments](https://getfloo.com/docs/guides/environments.md#the-flow).

```bash theme={null}
gh release create v1 --repo owner/repo
```

Wait for the prod deploy to finish, then read the DNS records:

```bash theme={null}
floo domains show app.example.com --app my-nuxt-app
```

Publish the traffic and certificate CNAME records that `show` prints, then watch
activation:

```bash theme={null}
floo domains watch app.example.com --app my-nuxt-app
```

Nuxt serves every host by default, so it needs no extra config. DNS setup and troubleshooting: [Custom domains](https://getfloo.com/docs/guides/custom-domains.md).

## 7. Local development with dev credentials

```bash theme={null}
floo dev --app my-nuxt-app
```

Runs `dev_command` locally with `DATABASE_URL` and readable env vars from the app's dev environment: a real connection to your dev Postgres, with no credentials in your shell history. Write-only secrets are withheld; supply separate local values when needed. Prod credentials never reach a local session.

The database exists after the first deploy that declares `[managed.default]`. Before that deploy, `floo dev` starts without `DATABASE_URL`.

To test signed-in flows, add `--fixture-user`:

```bash theme={null}
floo dev --app my-nuxt-app --fixture-user you@example.com
```

`floo dev` then puts a proxy in front of each accounts-mode service that injects the same `X-Floo-User-*` headers floo's gateway adds in production. The output table shows the raw service URL and the auth-proxied URL; use the auth-proxied one for any path that reads identity headers.

## Common gotchas

* **`/healthz` is reserved.** floo's edge intercepts that exact path. Use `/health` or `/livez`.
* **`--host 127.0.0.1` in `dev_command`.** On macOS the dev server listens on `::1` by default, and the `floo dev --fixture-user` proxy reaches it at `127.0.0.1`. Without the flag, proxied requests fail with an empty reply.
* **`HOST=0.0.0.0` in the final stage.** floo cannot reach a server bound to `localhost`.
* **`runtimeConfig` values.** Nuxt reads `NUXT_*` environment variables into `runtimeConfig` when the server starts. Set them with `floo env set`; they need no rebuild.
* **Public values at build time.** floo passes only `NEXT_PUBLIC_*`, `VITE_*`, and `REACT_APP_*` to the build. For a client value, use `runtimeConfig.public` with a `NUXT_PUBLIC_*` variable, which Nuxt reads at startup.

## Next steps

> [card] [App sign-in](https://getfloo.com/docs/guides/app-auth.md)
>
> Identity headers, access policies, and access modes in detail.

> [card] [Environment variables](https://getfloo.com/docs/guides/environment-variables.md)
>
> Secrets, build-time variables, and per-service values.

> [card] [Dockerfiles](https://getfloo.com/docs/guides/dockerfiles.md)
>
> Layer order for fast pushes and recommended multi-stage builds.

> [card] [Production environments](https://getfloo.com/docs/guides/environments.md)
>
> Dev vs prod, promotion, env overrides.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.