# Quickstart

Go from a new account to a merged test change on a connected GitHub repository.

## Prerequisites

- A GitHub account that can install a GitHub App on the client repository.
- The repository's default branch. The new-project screen labels it **Watching branch**.
- The public URL of the deployed site. Local addresses are rejected.

## Steps

1. Open the sign-in page. The heading is **Sign in to Modifee**. Press **Continue with GitHub**. The page says: "Use your GitHub account. We'll ask you to install the Modifee GitHub App on the repos you choose."
2. Open **Projects**. If no GitHub App is installed, the empty state is **Connect GitHub**, with the text "Install the GitHub App before creating a project." Press **Install GitHub App** and grant the repositories you want.
3. Press **New project**. If the list is empty, the empty state is **Connect your first repo** and the button is **Connect a repo**. Choose **Repository** and **Project name**, then press **Create project**. The form states "Approved changes open a pull request on this repo."
4. The project opens on the setup wizard, step **Connect**. Enter **Site URL** (placeholder `https://example.com`) and press **Continue**. You can change it later under **Settings → Connection → Site URL**.
5. On **Client access**, pick how the client opens the widget. **Public site, no login** asks for an email code. **Site with login** uses a server token. Add at least one address under **Who can request changes?** Press **Continue**. Details: [Auth methods](https://www.modifee.com/docs/client-access/auth-methods), [Allowed emails](https://www.modifee.com/docs/client-access/allowed-emails), [Access marker](https://www.modifee.com/docs/client-access/access-marker).
6. On **Install the widget**, press **Install automatically** or open **Install manually** and paste the snippet. Install guides: [Next.js App Router](https://www.modifee.com/docs/install/nextjs-app-router), [Next.js Pages Router](https://www.modifee.com/docs/install/nextjs-pages-router), [HTML and static sites](https://www.modifee.com/docs/install/html), [Other frameworks](https://www.modifee.com/docs/install/other-frameworks).
7. Save **Site URL** if you skipped it, deploy the site, then press **Check installation** under **Settings → Widget install**. Continue when the mark beside **Widget install** is green. See the install page for your stack.
8. On the project header, press **Send a test request**. When the site URL is saved and the last check is not unreachable, this opens the live site with the access marker, test mode, and the draft "Change the homepage heading to Welcome". Press **Send** in the widget. The banner says "Test mode — agency".
9. Watch the request in **Inbox** or the project's **Requests** tab. After a preview, press **Looks good** in the widget. Then either Autopilot merges it, or the status is **Needs your merge** and you press **Approve & merge**. The dialog says "Squash-merge this pull request into the default branch." See [Quotes and merges](https://www.modifee.com/docs/agency/quotes-and-merges) and [Autopilot and limits](https://www.modifee.com/docs/agency/autopilot-and-limits).

Previews are a separate wizard step, **Previews**. If the client cannot open the preview, see [Previews](https://www.modifee.com/docs/vercel/protected-previews) and [Preview problems](https://www.modifee.com/docs/troubleshooting/previews).

## Verify

The request status in the dashboard is **Merged**. The widget status is **Live**.

## Troubleshooting

- Sign-in: "This email is already linked to another sign-in method. Use the original method, or a different GitHub account." "Access was denied. Try again with the GitHub account you use for work." "Sign-in is temporarily unavailable. Try again in a moment." "Something went wrong while signing in. Try again."
- Repositories: `Could not load repositories for` and the GitHub account login. Press **Try again**. **No repositories available** links to **Configure GitHub App access**. **Don't see your repository?** opens the GitHub App settings. `Every repository from` the account login `is already connected to a project.` `This repository is already connected to a project.`
- Plan cap: "The Free plan includes 1 project." Other plans use the same sentence with their name and limit. The link beside it is **Upgrade to add another.**
- Site URL: "Enter a public http(s) URL." "Enter a public site URL. Local addresses can't be used here."
- Widget missing: [Widget not showing](https://www.modifee.com/docs/troubleshooting/widget-not-showing).
- "This email isn't allowed to request changes on this site." is [MDF-AUTH-002](https://www.modifee.com/docs/errors/MDF-AUTH-002). See [Email not allowed](https://www.modifee.com/docs/troubleshooting/email-not-allowed).
- "You've reached this month's request limit." is [MDF-QUOTA-001](https://www.modifee.com/docs/errors/MDF-QUOTA-001).
- "This workspace is over its plan limit." is [MDF-PLAN-001](https://www.modifee.com/docs/errors/MDF-PLAN-001).
- Preview will not open: [MDF-VERCEL-003](https://www.modifee.com/docs/errors/MDF-VERCEL-003) and [Preview problems](https://www.modifee.com/docs/troubleshooting/previews).
