> ## 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 React Router app on floo

> Deploy a React Router app with server rendering, Postgres, sign-in, and a custom domain.

From a React Router framework-mode project on GitHub (v7 or later) to a live app at `https://<app>.getfloo.app`, with server-rendered routes, managed Postgres, signed-in users, and your own domain. Remix v2 apps follow the same steps after the upgrade to React Router.

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, including a custom Express server if you need one.
* 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

This uses the project layout from `npx create-react-router@latest`, where `npm run build` runs `react-router build` and writes `build/client` and `build/server`. `@react-router/serve` runs the result. The starter ships its own `Dockerfile` and `.dockerignore`; replace the `Dockerfile` with this one, which orders layers for faster pushes:

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

FROM node:22-slim AS build
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .
RUN npm run build
RUN npm prune --omit=dev

FROM node:22-slim
WORKDIR /app
ENV NODE_ENV=production
COPY --from=build /app/package.json ./
COPY --from=build /app/node_modules ./node_modules
COPY --from=build /app/build ./build
CMD ["node_modules/.bin/react-router-serve", "./build/server/index.js"]
```

`react-router-serve` reads `PORT` and listens on every interface. Keep `@react-router/serve` in `dependencies`, which the starter template does, so `npm prune` leaves it in the image.

## 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-react-router-app
```

For a single-service React Router app:

```toml floo.app.toml theme={null}
[app]
name = "my-react-router-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"`. Keep that tool in `dependencies` so `npm prune` leaves it in the image, and copy its config and migration files into the final stage. 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-react-router-app
```

> [!TIP]
>
> **Your React Router app is live** at `https://my-react-router-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. The `.server.ts` suffix keeps the module out of the browser bundle:

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

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

```tsx app/routes/home.tsx theme={null}
import type { Route } from "./+types/home";
import { sql } from "~/db.server";

export async function loader() {
  const [{ now }] = await sql`select now()`;
  return { dbTime: now.toISOString() };
}

export default function Home({ loaderData }: Route.ComponentProps) {
  return <p>Database time: {loaderData.dbTime}</p>;
}
```

`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-react-router-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 React Router server.

Loaders and actions read the headers, with no auth code, callback handlers, or session storage:

```ts app/user.server.ts theme={null}
export function requireUser(request: Request) {
  const email = request.headers.get("x-floo-user-email");
  const id = request.headers.get("x-floo-user-id");
  if (!email || !id) {
    throw new Response("Sign in required", { status: 401 });
  }
  return { email, id, name: request.headers.get("x-floo-user-name") };
}
```

```tsx app/routes/dashboard.tsx theme={null}
import type { Route } from "./+types/dashboard";
import { requireUser } from "~/user.server";

export async function loader({ request }: Route.LoaderArgs) {
  return { user: requireUser(request) };
}

export default function Dashboard({ loaderData }: Route.ComponentProps) {
  return <h1>Hello, {loaderData.user.name ?? loaderData.user.email}</h1>;
}
```

Add the route to `app/routes.ts` with `route("dashboard", "routes/dashboard.tsx")`. 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-react-router-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-react-router-app
```

`react-router-serve` serves every host, 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-react-router-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-react-router-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.
* **`ssr: false` builds a static app.** With server rendering off in `react-router.config.ts`, there is no server to read identity headers or query the database. Keep the default `ssr: true`.
* **Client values at build time.** floo passes `VITE_*` variables to the build as build args. Thread them through the build stage as `ARG` plus `ENV` before `npm run build`. See [Build-time variables](https://getfloo.com/docs/guides/environment-variables.md#4-build-time-variables).
* **Keep database and secret code in `.server.ts` modules.** A module without the suffix can end up in the browser bundle.

## 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.