Getting started
Requirements
What your account, GitHub repository, framework and hosting need before you can connect a site to Ulika.
Last updated
Ulika can connect a site when four things are true: you have the right role in your Ulika workspace, the site's code is in a GitHub repository, the site uses a supported framework, and its host builds the site from that repository. This page lists each requirement and what to do if one is missing.
Quick checklist#
You are an owner or admin of an Ulika workspace.
Your site is public and served over https.
The code that builds the site is in a repository on GitHub.com that you can give Ulika access to.
The site is a Vite or React app, or a Next.js App Router app.
Your host builds the site automatically when you push to the repository (Vercel is the best supported host).
Your account#
A workspace and the owner or admin role#
Only workspace owners and admins can connect a website. If you have another role, the connect page shows the message Only owners and admins can connect a website and asks you to request an owner or admin to connect the site. After that, other roles can edit and publish according to their permissions. See Roles.
A GitHub account with access to the repository#
Ulika reads and writes through a GitHub App. You (or someone who owns the GitHub account that holds the repository) install it and choose which repositories it can see. If the repository belongs to an organization and you are not an owner of it, GitHub sends an owner a request. Ulika then tells you Your request was sent and asks you to come back after the owner approves. See The GitHub App.
Your website#
It must be reachable#
Ulika first reads your public pages to see what the site is built with. Your address must be public and use https. Sites on a private network or behind a VPN cannot be checked. If the site cannot be reached, you see We couldn't reach this website and the check does not continue.
It must have a codebase#
Ulika connects a codebase: it needs a repository to read and to add its connector to. That rules out sites that are hosted content with no repository behind them. If the check clearly detects one of these platforms, the connect page says This is a platform site and explains that it cannot be connected yet:
WordPress
Shopify
Wix
Squarespace
Webflow
Your framework#
| Framework | Connect from the dashboard | Notes |
|---|---|---|
| Vite + React | Yes | Connected with the build adapter. Works inside a monorepo folder too. |
Create React App (react-scripts) | Yes | Connected with the build adapter. |
| Other React apps with their own Node build | Yes | Needs react-dom and a build command, and must not be one of the frameworks below. |
| Next.js App Router | Yes | Connected with the generated runtime connector. The app needs a root layout (layout.tsx, layout.jsx, layout.js or layout.ts) with a <body> element. |
| Next.js Pages Router | No | The dashboard stops with We cannot generate a connector for this framework yet. |
| Astro, SvelteKit, Nuxt, Remix, Gatsby | No | The build adapter does not wrap these builds. |
| Static HTML with no build | No | There is no build for Ulika to wrap. |
Two more things to know:
Collections. The Vite and React build adapter cannot deliver sites that have collections (repeated content such as a blog list). The dashboard stops with This site's collections need a different connector.
The command line. The CLI scans React and Next.js projects from your own machine and can sometimes connect a project the dashboard cannot, such as a very large repository. It does not install on Astro, Svelte, Vue or plain HTML sites.
Your hosting#
Ulika does not host your site. Your host has to build the site from your repository on every push to the default branch. The table shows what Ulika does with each host.
| Host | How the connector starts the Ulika build | Ulika can see your build results | Extra integration |
|---|---|---|---|
| Vercel | buildCommand in vercel.json | Yes | Optional Vercel connection: preview checks, protection bypass |
| Netlify | [build] command in netlify.toml | Yes, through Netlify's GitHub App | None. See Netlify for what is and is not supported. |
| Cloudflare Pages | The build script in package.json | Yes, through the Cloudflare GitHub App | None |
| Render | The build script in package.json | Yes, through the Render GitHub App | None |
| Railway | The build script in package.json | Yes, through the Railway GitHub App | None |
| AWS Amplify | The build script in package.json | Yes, through the Amplify GitHub App | None |
| Anything else that builds from Git | The build script in package.json | No | None |
"Build results visible to Ulika" means that the host's official GitHub App reports builds and Ulika is allowed to read them. Ulika reads three things from GitHub, read-only: commit statuses, checks and deployments. If your GitHub installation has not accepted those permissions yet, the dashboard shows Approve Ulika's updated GitHub permissions. Until you approve, everything keeps working, and Ulika checks your live site after merging instead. See The GitHub App.
Seeing a host's build results is not the same as seeing every kind of failure. Ulika's automatic undo of a failed live build relies on a production deployment reported through GitHub (or through the Vercel connection). Netlify and Cloudflare Pages report production builds in a different way, so Ulika does not see their production failures today. See Approving a connection.
What "the build entry" means#
Ulika's build step has to run when your host builds the site. The connector makes that happen with one edit:
On Vercel (a
vercel.jsonexists, or the site is known to be on Vercel),buildCommandbecomesnode .ulika/build.mjs.On Netlify (a
netlify.tomlexists), thecommandline in[build]becomesnode .ulika/build.mjs. Every other line is left as it was.On any other host,
scripts.buildinpackage.jsonbecomesnode .ulika/build.mjsand your original build moves to a script namedbuild:site.
Your original build command is recorded in .ulika/connector.json, and it runs unchanged inside the Ulika build.
Hosts other than Vercel and Netlify#
For hosts that run npm run build, the build step works because the wrapped script is what the host runs. This has one catch. If Ulika can see the command your host runs and it skips the script (for example, vite build), Ulika stops and tells you: set the host's build command to npm run build, then try again. If Ulika cannot see your host's command, it assumes npm run build. If your host actually runs something else, publishing will not apply your content.
Hosts Ulika recognizes#
Ulika recognizes these hosts by who reported the build, not by what a status says. Only builds reported by their official GitHub Apps count: Vercel, Netlify, Cloudflare Workers and Pages, Render, Railway and AWS Amplify. A preview address is trusted only when it belongs to that host's own domain or to your site.
Your repository#
| Requirement | Why |
|---|---|
| It is on GitHub.com | Ulika connects through a GitHub App. Other Git providers are not supported by the dashboard. |
| One workspace per repository | A repository can be connected in only one Ulika workspace at a time. Another workspace gets This repository is connected in another workspace. |
No unrelated .ulika/ files | Ulika will not overwrite files it did not write. |
| The site has a build | A build script, or a build command on the hosting project. Otherwise you see We could not find how this site builds. |
| The host builds from the same folder | In a monorepo, the hosting project's root directory must match the folder the site lives in. Otherwise you see The hosting project builds from a different folder. |
| No unpublished edits waiting | A connector commit is public source code and cannot carry drafts. Publish or discard pending edits first. |
| Size within the limits below | Ulika reads a copy of the repository in memory with fixed limits. |
Size limits#
Ulika reads your repository inside fixed budgets. If a repository goes over one, the dashboard names the limit.
| Limit | Value |
|---|---|
| Download size | 512 MB |
| Uncompressed size | 1 GB |
| Files inspected | 3,000 |
| Size of one file | 256 KB (larger files are skipped, not read) |
| Editable fields | 2,000 |
| Time | 60 seconds |
Repositories over 500 MB, or with large videos in Git, also get a warning. Moving media out of Git (Git LFS or your host's storage) makes reading faster.
Branch protection#
Ulika opens the connector as a pull request and then merges it. If your default branch requires reviews or checks that Ulika cannot satisfy, the dashboard leaves the pull request open and offers Prefer GitHub? Review and merge PR #N. Merge it yourself. Ulika never asks to bypass your protection rules.
On your computer (command line only)#
If you connect with the CLI, you need Node.js 20 or newer and nothing else installed, because the CLI runs through npx. Connecting by URL from any computer works with no checkout. A local scan of a checkout (--dir) also needs Git. Connecting through your own Vercel and GitHub command-line tools is optional and only used when you ask for a local connection.
Next steps#
Follow the Quickstart.
Read about connecting from the dashboard.
Was this page helpful?