Quick Start

Get your project deployed and preview environments running in a few steps.

1. Sign up or log in

   Go to fluxnow.app and sign up or log in with your GitHub account.

2. Add fluxnow.yaml to your repo — first

   fluxnow.yaml is the source of truth for your app: it declares the runtime, port, build strategy, and which services to provision. Commit it to your default branch before you install the GitHub App — onboarding reads it at install time (see the callout below).

   fluxnow.yaml

   version: v1
   kind: Service
   metadata:
     name: my-app
   spec:
     runtime: node
     port: 3000
   db:
     enabled: true      # Postgres (on by default)
   redis:
     enabled: true      # dedicated Valkey instance
   s3:
     enabled: true      # object storage bucket

   For multiple apps in one repo, use kind: Monorepo — see Monorepo Support.

3. Install the FluxNow GitHub App

   From fluxnow.app (during signup, or any time from Settings), install the FluxNow GitHub App on your organization or personal account and grant it access to the repo. Installing the app is what triggers onboarding.

4. FluxNow onboards your repo

   On install, FluxNow reads the fluxnow.yaml on your default branch, provisions the requested services (Postgres, Redis, S3), and opens a pull request to your repo with the deploy scaffolding — Helm values and CI workflows.

5. Merge to deploy

   Merge that PR. Your app builds and deploys, and a preview environment is created for every subsequent PR.

Order matters

Onboarding runs when you install the GitHub App and reads whatever fluxnow.yaml is on your default branch at that moment. Commit fluxnow.yaml before installing (or re-installing) the app. If you install first, FluxNow falls back to auto-detecting the runtime — add fluxnow.yaml and re-install to onboard against your intended config.

What happens next

From this point on:

• Every pull request gets its own isolated preview environment at a unique URL.
• Merging to your default branch (main or master) automatically deploys to staging.

Configuration lives in fluxnow.yaml in your repo. A dashboard for managing services and deploys is on the roadmap.