Skip to content

Quickstart

This guide takes you from zero to a working preview deployment in under five minutes. You’ll need a GitHub repository (public or private) and permission to install GitHub Apps on it.

1. Sign up

Go to app.yofix.ai/login. Sign up with GitHub. No credit card required.

2. Install the GitHub App

From your workspace dashboard, click Connect repository. You’ll be redirected to GitHub to install the YoFix App. Choose All repositories or pick specific ones.

The App requests:

  • contents: read: clone your repo for builds.
  • pull_requests: write: post and update the preview comment.
  • metadata: read: detect the framework and lockfile.
  • webhooks: react to pushes and PR events.

3. We detect everything

When you select a repository, YoFix scans the codebase and detects:

  • Framework: Next.js, Vite, Remix, Astro, SvelteKit, Nuxt, Angular, CRA, plain static.
  • Package manager: npm, yarn (v1 and v4), pnpm, bun.
  • Node version: from .nvmrc, .node-version, package.json engines, or sensible default.
  • Monorepo structure: Turborepo, Nx, Lerna, pnpm workspaces.

You can override any of these in Project settings → Build.

4. Push a PR

That’s it. Open any pull request against your default branch. Within seconds you’ll see:

  • A new deployment row in your YoFix dashboard showing Building.
  • A YoFix bot comment on the PR appearing as soon as the build starts.

When the build finishes, the comment is updated in place with:

  • A Visit Preview link to your-branch.yofix.dev.
  • Build duration and status.
  • Visual regression results across all changed routes.
  • A link back to the YoFix detail page for logs.

5. Review and promote

Open the preview URL and sanity-check the change. If VRT flagged anything, review the highlighted diffs in the dashboard and approve or reject each. When everything looks good, merge the PR.

On merge to main, YoFix automatically promotes the verified preview artifact to production. No second build. No drift between what you reviewed and what you shipped.

If anything looks wrong in production, Rollback is one click and completes in under ten seconds.

Next